Skip to main content
POST
/
organizations
/
admin
/
invites
Generate an invite
curl --request POST \
  --url https://api.pcxpay.com/v1/organizations/admin/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "org_id": "<string>",
  "name": "<string>",
  "role": "<string>",
  "email": "jsmith@example.com",
  "invited_by": "<string>"
}
'
{
  "status": "<string>",
  "message": "<string>",
  "data": {}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
org_id
string
required
name
string
required
role
string
required
email
string<email>
required
invited_by
string

Response

201 - application/json

Invite generated

status
string
message
string
data
object