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.
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.
Hide attributes
string
required
Invitee email address.
string
required
Role assigned on acceptance. owner and admin hold every permission; member can read and can manage webhooks. One of: owner, admin, member.
string
required
Invitation status. One of: pending, accepted, revoked, declined. See Statuses.
object
required
Metadata visible to anyone who can read the resource.
string
required
RFC 3339 timestamp when this invitation expires.
string
required
RFC 3339 timestamp when this invitation was created.
string | null
required
RFC 3339 timestamp when this invitation was accepted, or null.
Statuses
Status
Meaning
Can become
pending
Sent and not answered yet. It stays pending after expiresAt, but it can no longer be accepted.
accepted, declined, revoked
accepted
The person accepted and joined the party with role.