NAnatural
External Parties

Create external party

Changed on

Create an external party to transact with over Direct

post/external-parties

Request

  • Base URL
    https://api.natural.com
  • URL
    https://api.natural.com/external-parties
  • Auth
    HTTP bearer

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

  • 226131258c12Revision changes
    • info

      added the required property // to the response with the status

  • ccc52bdd2ca7Revision changes
    • breaking

      the request property /// became required

    • breaking

      the request property /// became required

    • breaking

      the request property /// became required

    • breaking

      added the pattern ^[A-Za-z]{2}$ to the request property ///

    • info

      the /// request property's minLength was decreased from 2 to 0