Create an invitation

Invite someone to your Quo workspace and send them an invitation email. A pending invitation occupies a billable seat, so creating one changes your subscription.

POST /invites

Create an invitation

cURL

curl --request POST \
  --url https://dev-public-api.openphone.dev/invites \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Quo-Api-Version: <quo-api-version>' \
  --data '
{
  "email": "[e-mail]",
  "role": "member",
  "phoneNumberId": "PN123abc",
  "phoneNumberIds": [
    "<string>"
  ]
}
'

201

{
  "data": {
    "id": "IV123abc",
    "phoneNumberId": "PN123abc",
    "email": "[e-mail]",
    "phoneNumberIds": [
      "<string>"
    ],
    "role": "member",
    "status": "pending",
    "acceptedAt": "2022-01-01T00:00:00Z",
    "acceptedBy": "US456def",
    "cancelledAt": "2022-01-01T00:00:00Z",
    "createdAt": "2022-01-01T00:00:00Z",
    "invitedBy": "US123abc",
    "updatedAt": "2022-01-01T00:00:00Z"
  }
}

Authorizations

Authorization · string · header · required

Headers

Quo-Api-Version · enum<string> · required

API version header. Supported values: 2026-03-30

Available options: 2026-03-30

Body

application/json

email · string<email> · required

The email address to invite. Must not already have a pending invitation in this workspace.

Example:

"[e-mail]"

role · enum<string> · required

The role the invited person will hold. Only an owner can invite an owner, and only an owner or admin can invite an admin.

Available options: owner, admin, member

Example:

"member"

phoneNumberId · string | null

A phone number to assign the invited person to.

Pattern: ^PN(.*)$

Example:

"PN123abc"

phoneNumberIds · string[]

Pattern: ^PN(.*)$

Response

201

application/json

Created

data · object · required

Show child attributes