Set Name

API Reference

V1

Customers

Update a customer name

client.v1.customers.setName(CustomerSetNameParamsparams, RequestOptionsoptions?): dataCustomerCustomerSetNameResponse

post/v1/customers/{customer_id}/setName

Updates the specified customer's name.

Parameters

paramscustomer_idstringnamestringCustomerSetNameParams

Hide ParametersShow Parameters

customer_idstring

Path param:

formatuuid

namestring

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

Returns

CustomerSetNameResponse

Hide ParametersShow Parameters

dataidstringexternal_idstringingest_aliasesarraynamestringcustom_fieldsRecord<string, string>Customer

HTTPTypeScriptPythonGoRubyTerraform

import Metronome from '@metronome/sdk';

const client = new Metronome({
  bearerToken: 'My Bearer Token',
});

const response = await client.v1.customers.setName({
  customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
  name: 'Example, Inc.',
});

console.log(response.data);

200 Example

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