Sign in
Simulations

Invite test customer

Create a test customer and a pending invitation for each agent you name

post/simulations/invite-customer

Headers

Idempotency-Keystring required

Unique key for safely retrying a request without creating duplicates.

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 7 of the 28 revisions of this API.518

  • 359d267dca881See the full diff
    • ○

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

      request-parameter-removed-with-deprecation

  • feb2ede065391See 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 200

      response-property-enum-value-added

  • 6c995d8e801c1See the full diff
    • ○

      added the new optional request property data/attributes/message

      new-optional-request-property

  • b1ad79e918ac2See the full diff
    • ○

      header request parameter X-Agent-ID was deprecated

      request-parameter-deprecated

    • ○

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

      request-property-enum-value-added

  • a77f94c2883a1See the full diff
    • ○

      added the new optional request property data/attributes/permissions

      new-optional-request-property

  • 68aaf2076cfc52See the full diff
    • ▲

      the data response's property type/format changed from object/ to array/ for status 200

      response-property-type-changed

    • ▲

      removed the required property data/attributes from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property data/id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property data/relationships from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property data/type from the response with the 200 status

      response-required-property-removed

    • ○

      the request property data/attributes/type became optional

      request-property-became-optional

    • ○

      added the required property meta to the response with the 200 status

      response-required-property-added

  • 0e0686ff0b441See the full diff
    • ○

      endpoint added

      endpoint-added