Set Name

API Reference

V1

Customers

Update a customer name

post/v1/customers/{customer_id}/setName

Updates the specified customer's name.

Path Parameters

customer_idstring

formatuuid

Body Parameters

namestring

The new name for the customer. This will be truncated to 160 characters if the provided name is longer.

Returns

dataidstringexternal_idstringingest_aliasesarray of stringnamestringcustom_fieldsmapCustomer

HTTPTypeScriptPythonGoRubyTerraform

curl https://api.metronome.com/v1/customers/$CUSTOMER_ID/setName \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $METRONOME_BEARER_TOKEN" \
    -d '{
          "name": "Example, Inc."
        }'

200 Example

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "external_id": "external_id",
    "ingest_aliases": [
      "string"
    ],
    "name": "name",
    "custom_fields": {
      "foo": "string"
    }
  }
}