TOtogaihq
Customers

Update a customer

Changed on

This API let’s you to update a customer’s information using customer_id.

patch/customers/{customer_id}

Request

Path parameters

customer_idstring required
Example:01BX5ZZKBKACTAV9WEVGEMMVRZ

Request body

namestring

Name of the Customer

primaryEmailstring

Primary email of the customer

Example request

{
  "name": "ACME Enterprise",
  "primaryEmail": "admin@example.com"
}

Response

Response for Get customer requests

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 required

billing address of the customer

status'ACTIVE' | 'ARCHIVED' required

Status of the customer

createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "billingAddress": "201 Boulevard, WA 53123",
  "status": "ACTIVE"
}

Changes

  • 6fb940b0dad9Revision changes
    • breaking

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

    • info

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

    • info

      added the required property to the response with the status

  • a6c96c5ec06eRevision changes
    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status