NAnatural
Invitation Links

Get invitation link

Changed on

Get an invitation link and its offered agents, with a masked token

get/customers/invitation-links/{linkId}

Request

  • Base URL
    https://api.natural.com
  • URL
    https://api.natural.com/customers/invitation-links/{linkId}
  • Auth
    HTTP bearer

Path parameters

linkIdstring required

Invitation link ID (ivl_*).

Headers

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Response

Successful Response

Changes

  • c840b58ae52dRevision changes
    • warning

      added the new savedCards.use enum value to the ///// response property for the response status

    • warning

      added the new saved_cards.use enum value to the ///// response property for the response status

  • 125e70fb6f0fRevision changes
    • warning

      added the new cardPayments.read enum value to the ///// response property for the response status

    • warning

      added the new externalAccounts.create enum value to the ///// response property for the response status

    • warning

      added the new externalAccounts.read enum value to the ///// response property for the response status

    • warning

      added the new externalParties.create enum value to the ///// response property for the response status

    • warning

      added the new externalParties.read enum value to the ///// response property for the response status

    • warning

      added the new paymentIntents.create enum value to the ///// response property for the response status

    • warning

      added the new paymentIntents.read enum value to the ///// response property for the response status

    • warning

      added the new paymentRequests.create enum value to the ///// response property for the response status

    • warning

      added the new paymentRequests.read enum value to the ///// response property for the response status

    • warning

      added the new voiceSessions.create enum value to the ///// response property for the response status

    • warning

      added the new voiceSessions.read enum value to the ///// response property for the response status