Skip to main content
A party invitation (inv_*) asks a person, by email, to join your business party as a teammate. To connect an agent to another party instead, see Invite a customer.

Example

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

Fields

string
required
Resource type. Always invitation.
string
required
Invitation ID (inv_*).
object
required
The invitation’s details.

Statuses

Events

This resource sends no webhook events.

Errors

See the error codes these endpoints return.

Sandbox simulations

None.