Skip to main content
A customer invitation groups your pending invitations by recipient email. To learn more, see Invite a customer.
Inviting and revoking return a different object today: agentDelegationInvitation, one per recipient and agent, with its own fields.

Example

GET /customers/invitations
The object is each element of data; this shows the first one. The field names below are relative to it: attributes.status is data[].attributes.status in the response.

Fields

string
required
Resource type. Always customerInvitation.
string
required
Recipient email.
object
required
The recipient’s pending invitations.

Which invitations are listed

Only pending invitations that haven’t expired. In Live, an invitation sent to a phone number isn’t listed. In Sandbox, a phone invitation goes to your test customer and is listed under that customer’s email. Events about these invitations carry each invitation in agentInvitations, not this object: agentConnectionInvitation.created, .accepted, .declined and .canceled (Agent connection invitations).

Events

This resource sends no webhook events.

Other objects

These endpoints in the group don’t return this object:
  • Invite customers (POST /customers/invitations) returns a agentDelegationInvitation object.
  • Revoke customer invitation (DELETE /customers/invitations/{invitationId}) returns a agentDelegationInvitation object.

Errors

See the error codes these endpoints return.

Sandbox simulations