PUT
/
v1
/
customers
/
by-external-id
/
{externalId}
Update customer by external ID
curl --request PUT \
  --url https://api.useaira.com/v1/customers/by-external-id/{externalId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "name": "Acme Inc.",
  "customFields": {
    "custom_field_1": "value1",
    "custom_field_2": "value2"
  }
}'
{
  "id": "<string>",
  "externalId": "cust_1234567890abcdef",
  "name": "Acme Inc.",
  "customFields": {
    "custom_field_1": "value1",
    "custom_field_2": "value2"
  }
}

Authorizations

​
X-API-KEY
string
header
required

API Key Authentication.

Path Parameters

​
externalId
string
required

An optional external identifier of the customer from the external system, used throughout the system to identify the customer. This field can not be updated.

Body

application/json

Schema representing a customer.

​
name
string
required

The name of the customer.

Example:

"Acme Inc."

​
customFields
object

Custom fields that can be associated with the customer. The fields must be previously created in the system before they can be used.

Example:
{
  "custom_field_1": "value1",
  "custom_field_2": "value2"
}

Response

The request was successfully processed, and the customer has been updated. The response contains the details of the updated customer.

​
id
string
required

The unique identifier of the customer in our system.

​
externalId
string
required

An optional external identifier of the customer from the external system, used throughout the system to identify the customer. This field can not be updated.

Example:

"cust_1234567890abcdef"

​
name
string
required

The name of the customer.

Example:

"Acme Inc."

​
customFields
object

Custom fields that can be associated with the customer. The fields must be previously created in the system before they can be used.

Example:
{
  "custom_field_1": "value1",
  "custom_field_2": "value2"
}