Update an invitation

Update a pending invitation. Fields you omit are left unchanged; phoneNumberIds is replaced wholesale by the list you send. Accepted and cancelled invitations cannot be modified.

PATCH /invites/{inviteId}

Update an invitation

cURL

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

200

{
  "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

Path Parameters

inviteId · string · required

The unique identifier of the invitation.

Pattern: ^IV(.*)$

Example:

"IV123abc"

Body

application/json

role · enum<string>

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

Available options: owner, admin, member

Example:

"admin"

phoneNumberId · string | null

Replaces the assigned phone number. Pass null to clear it.

Pattern: ^PN(.*)$

Example:

"PN123abc"

phoneNumberIds · string[]

Pattern: ^PN(.*)$

Response

200

application/json

OK

data · object · required

Show child attributes