TOtogaihq
Customers

Create a customer

Changed on

This API let’s you to create customers and corresponding accounts.

post/customers

Request

Request body

idstring required

Customer identifier

namestring required

Name of the Customer

primaryEmailstring required

Primary email of the customer

Example request

{
  "id": "01BX5ZZKBKACTAV9WEVGEMMVRZ",
  "name": "ACME Enterprise",
  "primaryEmail": "admin@example.com",
  "account": {
    "id": "ACC00001",
    "name": "Primary Account",
    "primaryEmail": "admin@example.com",
    "netTermDays": 45
  }
}

Response

Response for Create customer request

idstring required

Identifier of customer

togaiCustomerIdstring required

Unique identifier of customer

namestring required

Name of the Customer

primaryEmailstring required

Primary email of the customer

billingAddressstring

Example response

{
  "account": {
    "invoiceCurrency": "USD",
    "primaryEmail": "admin@example.com",
    "status": "ACTIVE"
  }
}

Changes

  • 3135bb8c67b3Revision changes
    • info

      added the optional property / to the response with the status

  • 6fb940b0dad9Revision changes
    • breaking

      the response property / became optional for the status

    • breaking

      the / response property's maxLength was increased from 255 to 320 for the response status

    • breaking

      the response property's maxLength was increased from 255 to 320 for the response status

    • warning

      added the new DRAFT enum value to the / response property for the response status

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      the / request property's maxLength was increased from 255 to 320

    • info

      the request property's maxLength was increased from 255 to 320

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property to the response with the status