Set Name

API Reference

V1

Customers

Update a customer name

v1.customers.set_name(CustomerSetNameParams**kwargs) -> dataCustomerCustomerSetNameResponse

post/v1/customers/{customer_id}/setName

Updates the specified customer's name.

Parameters

customer_idstr

formatuuid

namestr

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

Returns

CustomerSetNameResponseclass

Hide ParametersShow Parameters

dataidstrexternal_idstringest_aliaseslistnamestrcustom_fieldsDict[str, str]Customer

HTTPTypeScriptPythonGoRubyTerraform

from metronome import Metronome

client = Metronome(
    bearer_token="My Bearer Token",
)
response = client.v1.customers.set_name(
    customer_id="d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
    name="Example, Inc.",
)
print(response.data)

200 Example

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