Every field of a pending customer invitation, grouped by recipient
A customer invitation groups your pending invitations by recipient email. To learn more, see Invite a customer.
Inviting, getting one invitation and revoking return a different object today: agentDelegationInvitation, one per recipient and agent, with its own fields.
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.
Hide attributes
string
required
Always pending.
object | null
required
Customer party, or null until they join Natural.
Hide party
string
required
Customer party ID (pty_*).
string
required
Customer name.
string | null
required
Email address.
string | null
required
Primary phone number in E.164 format, or null when none is on file.
string | null
required
Public avatar URL, or null when none is set.
string | null
required
RFC 3339 timestamp when the customer’s party was created, or null when unknown.
string
required
Recipient email.
string
required
RFC 3339 timestamp when the invitation was created.
object[]
required
Agent invitations sent to this recipient.
Hide agentInvitations
string
required
Invitation ID (adi_*).
object
required
Invited agent.
Hide agent
string
required
Agent ID (agt_*).
string | null
required
Agent name.
string | null
required
Agent handle, such as @acme-support, or null when none is set.
string[]
required
Permissions requested for this agent. Each item is one of: disputes.read, disputes.create, payments.read, payments.create, externalParties.read, externalParties.create, direct.read, direct.create, externalAccounts.create, wallets.read, wallets.balance, wallets.create, wallets.update, wallets.fund, wallets.deposit, wallets.transfer, wallets.withdraw, party.read, party.update, paymentIntents.create, paymentIntents.read, cardPayments.read, refunds.read, refunds.create, voiceSessions.read, voiceSessions.create, chargebacks.read, chargebacks.respond, mandates.read, enrollment.read, cards.read, savedCards.use, paymentRequests.read, paymentRequests.create, externalAccounts.read.
string
required
Invitation URL. Natural sends it automatically for email invitations; deliver it yourself for phone invitations.
string
required
RFC 3339 timestamp when the invitation was created.
string | null
required
RFC 3339 timestamp when the invitation expires, or null when it never expires.
object
required
Metadata visible to anyone who can read the resource.
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.
Related events
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.
Get customer invitation (GET /customers/invitations/{invitationId}) returns a agentDelegationInvitation object.
Revoke customer invitation (DELETE /customers/invitations/{invitationId}) returns a agentDelegationInvitation object.