Sign in
Customers

Invite customers

Invite specific customers by email or phone to approve a set of your agents, each with its own permissions and limits

post/customers/invitations

Headers

X-Instance-IDstring nullable

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

Request body

Response

Successful Response

Changes

Changed in 14 of the 28 revisions of this API.61125

  • 359d267dca881See the full diff
    • ○

      deleted the header request parameter X-Agent-ID with deprecation

      request-parameter-removed-with-deprecation

  • feb2ede0653911See the full diff
    • ●

      added the new CONNECTION_ESTABLISHED enum value to the data/items/attributes/cancelReason/anyOf[subschema #1]/ response property for the response status 201

      response-property-enum-value-added

    • ○

      added the required property meta/alreadyConnected to the response with the 201 status

      response-required-property-added

  • b1ad79e918ac72See the full diff
    • ●

      removed the request property data/attributes/disableNotifications

      request-property-removed

    • ●

      removed the request property data/attributes/recipients/items/anyOf[subschema #1: Email recipient]/accountType

      request-property-removed

    • ●

      removed the request property data/attributes/recipients/items/anyOf[subschema #1: Email recipient]/business

      request-property-removed

    • ●

      removed the request property data/attributes/recipients/items/anyOf[subschema #1: Email recipient]/firstName

      request-property-removed

    • ●

      removed the request property data/attributes/recipients/items/anyOf[subschema #1: Email recipient]/individual

      request-property-removed

    • ●

      removed the request property data/attributes/recipients/items/anyOf[subschema #1: Email recipient]/lastName

      request-property-removed

    • ●

      removed the request property data/attributes/recipients/items/anyOf[subschema #1: Email recipient]/phone

      request-property-removed

    • ○

      header request parameter X-Agent-ID was deprecated

      request-parameter-deprecated

    • ○

      added the new wallets.balance enum value to the request property data/attributes/agents/items/permissions/items/

      request-property-enum-value-added

  • a77f94c2883a11See the full diff
    • ●

      removed the request property data/attributes/recipients/items/anyOf[subschema #1: Email recipient]/beneficialOwners

      request-property-removed

    • ○

      added the new optional request property data/attributes/recipients/items/anyOf[subschema #1: Email recipient]/business/beneficialOwners

      new-optional-request-property

  • a4ce0bec531512See the full diff
    • ▲

      removed subschema #1 subschema #2 subschema #3 from the data/attributes/recipients/items/ request property anyOf list

      request-property-any-of-removed

    • ○

      added the new optional request property data/attributes/message

      new-optional-request-property

    • ○

      added subschema #1: Email recipient subschema #2: Phone recipient subschema #3: Existing customer to the data/attributes/recipients/items/ request property anyOf list

      request-property-any-of-added

  • d977b644015a11See the full diff
    • ▲

      removed subschema #1 subschema #2 from the data/attributes/recipients/items/ request property anyOf list

      request-property-any-of-removed

    • ○

      added subschema #1 subschema #2 to the data/attributes/recipients/items/ request property anyOf list

      request-property-any-of-added

  • 09487fd56e295See the full diff
    • ○

      added the new wallets.create enum value to the request property data/attributes/agents/items/permissions/items/

      request-property-enum-value-added

    • ○

      added the new wallets.deposit enum value to the request property data/attributes/agents/items/permissions/items/

      request-property-enum-value-added

    • ○

      added the new wallets.fund enum value to the request property data/attributes/agents/items/permissions/items/

      request-property-enum-value-added

    • ○

      added the new wallets.transfer enum value to the request property data/attributes/agents/items/permissions/items/

      request-property-enum-value-added

    • ○

      added the new wallets.withdraw enum value to the request property data/attributes/agents/items/permissions/items/

      request-property-enum-value-added

  • ba1fb54c59391See the full diff
    • ○

      the data/attributes/tags/propertyNames/ request property's maxLength was increased from 64 to 128

      request-property-max-length-increased

  • 089aed4017a822See the full diff
    • ▲

      removed the enum value direct_payments.create of the request property data/attributes/agents/items/permissions/items/

      request-property-enum-value-removed

    • ▲

      removed the enum value direct_payments.read of the request property data/attributes/agents/items/permissions/items/

      request-property-enum-value-removed

    • ○

      added the new direct.create enum value to the request property data/attributes/agents/items/permissions/items/

      request-property-enum-value-added

    • ○

      added the new direct.read enum value to the request property data/attributes/agents/items/permissions/items/

      request-property-enum-value-added

  • 0123533d83612See the full diff
    • ○

      added the new direct_payments.create enum value to the request property data/attributes/agents/items/permissions/items/

      request-property-enum-value-added

    • ○

      added the new direct_payments.read enum value to the request property data/attributes/agents/items/permissions/items/

      request-property-enum-value-added