POST
/
tenants
/
members
/
invite
curl --request POST \
  --url https://api.pxyz.dev/api/v0/tenants/members/invite \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantId": "<string>",
  "email": "jsmith@example.com",
  "roleAdmin": true,
  "roleEditOrganizations": true,
  "roleEditUsers": true,
  "roleEditConfig": true,
  "roleViewUsers": true,
  "roleViewOrganizations": true,
  "roleViewConfig": true,
  "roleViewBilling": true,
  "roleEditBilling": true
}'
{
  "id": "<string>",
  "tenantId": "<string>",
  "tenant": {
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "logoId": "<string>",
    "iconId": "<string>",
    "environment": "development",
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "email": "jsmith@example.com",
  "userId": "<string>",
  "user": {
    "id": "<string>",
    "emailAddresses": [
      {
        "id": "<string>",
        "email": "jsmith@example.com",
        "verifiedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "primaryEmailId": "<string>",
    "name": "<string>"
  },
  "roleAdmin": true,
  "roleEditOrganizations": true,
  "roleEditUsers": true,
  "roleEditConfig": true,
  "roleViewUsers": true,
  "roleViewOrganizations": true,
  "roleViewConfig": true,
  "roleViewBilling": true,
  "roleEditBilling": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Body

application/json
tenantId
string
required
email
string
required
roleAdmin
boolean
roleEditOrganizations
boolean
roleEditUsers
boolean
roleEditConfig
boolean
roleViewUsers
boolean
roleViewOrganizations
boolean
roleViewConfig
boolean
roleViewBilling
boolean
roleEditBilling
boolean

Response

200 - application/json
id
string
required
tenantId
string
required
tenant
object | null
email
string
required
userId
string | null
user
object | null
roleAdmin
boolean
required
roleEditOrganizations
boolean
required
roleEditUsers
boolean
required
roleEditConfig
boolean
required
roleViewUsers
boolean
required
roleViewOrganizations
boolean
required
roleViewConfig
boolean
required
roleViewBilling
boolean
required
roleEditBilling
boolean
required
createdAt
string
required
updatedAt
string
required