Skip to main content
An invitation link (ivl_*) offers your agents to any customer who opens its URL. To learn more, see Share an invitation link.

Example

GET /customers/invitation-links/{linkId}
The object is everything inside data. The field names below are relative to it: attributes.proposedAgents is data.attributes.proposedAgents in the response.

Fields

string
required
Resource type. Always invitationLink.
string
required
Invitation link ID (ivl_*).
object
required
The link’s details.
object
required
Related resources, each by type and ID.

Statuses

Events

Endpoint differences

These endpoints return the object with a difference:
  • POST /customers/invitation-links also returns the plaintext token and url, the only time they are shown. Reads return maskedToken instead.
  • POST /customers/invitation-links does not return maskedToken; read the link to get it.

Errors

See the error codes these endpoints return.

Sandbox simulations

None.