Skip to main content
POST
/
organizations
/
{org_id}
/
members
Add a member to an organization
curl --request POST \
  --url https://api.pcxpay.com/v1/organizations/{org_id}/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "role": "<string>",
  "invited_by_user_id": "<string>"
}
'
{
  "status": "<string>",
  "message": "<string>",
  "data": {
    "user_id": "<string>",
    "org_id": "<string>",
    "user_email": "<string>",
    "user_first_name": "<string>",
    "user_last_name": "<string>",
    "user_phone": "<string>",
    "org_name": "<string>",
    "invited_by": "<string>",
    "invited_by_name": "<string>",
    "role": "admin",
    "status": "invited",
    "permissions": [
      {
        "resource": "<string>",
        "resource_name": "<string>",
        "actions": [
          "READ"
        ],
        "constraints": {},
        "granted_by": "<string>",
        "granted_by_name": "<string>",
        "granted_at": "2023-11-07T05:31:56Z"
      }
    ],
    "joined_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

org_id
string
required

Body

application/json
email
string<email>
required
role
string

Not required — defaults applied by domain

invited_by_user_id
string

Response

Member created

status
string
message
string
data
object