Update customer

Update an existing customer.

PUT /customers/{customerId}

cURL

updateContact

curl --request PUT \
  --url https://apiv2.example.com/customers/{customerId} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "contact": {
    "email": "[e-mail]",
    "msisdn": "[phone]"
  }
}
'

200

{
  "customerId": "<string>",
  "customerType": "CONSUMER",
  "name": "<string>",
  "contact": {
    "email": "[e-mail]",
    "msisdn": "<string>"
  },
  "identity": "<string>",
  "preferredLocale": "en-US",
  "humanReadableId": "29A-BY3Z-X78",
  "referenceId": "crm-customer-12345",
  "billing": {
    "method": "E_INVOICE",
    "currency": "USD",
    "email": "[e-mail]",
    "address": {
      "street1": "500 S Main St",
      "city": "Natick",
      "zip": "01701",
      "country": "US",
      "street2": "Apt 1",
      "state": "CA",
      "region": "<string>",
      "attention": "<string>"
    },
    "defaultPaymentProfileId": "c1d2e3f4-a5b6-7890-1234-901234567890",
    "autoPay": true
  },
  "users": [
    {
      "userId": "<string>",
      "name": "<string>",
      "role": "MEMBER"
    }
  ],
  "contactPerson": {
    "userId": "<string>",
    "name": "<string>",
    "role": "MEMBER"
  },
  "shipping": {
    "name": "John Doe",
    "address": {
      "street1": "500 S Main St",
      "city": "Natick",
      "zip": "01701",
      "country": "US",
      "street2": "Apt 1",
      "state": "CA",
      "region": "<string>",
      "attention": "<string>"
    },
    "msisdn": "[phone]",
    "instructions": "Leave at front door"
  },
  "metadata": {}
}

Authorizations

apiKeybearerAuth & apiKey

X-Api-Key · string · header · required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Headers

X-Idempotency-Key · string

A unique key to ensure idempotency of requests. If a request with the same key has already been processed, the same result will be returned. The key must be unique for each distinct operation. Keys are expired after 24 hours, but we recommend using a new key for each request.

Modified requests with the same idempotency keys are rejected with a 409 Conflict status code.

Maximum string length: 256

Path Parameters

customerId · string · required

The unique identifier of the customer. May be the entity's internal UUID or an external reference identifier. Reference identifiers MUST be prefixed with rid_ (e.g., rid_crm-customer-12345) so the API can distinguish them from internal UUIDs. The prefix is stripped before lookup.

Body

application/json

Request to update a customer.

name · string

Name of the customer.

Example:

"John Doe"

identity · string

The identity of the entity, such as personal number, organization number, etc., depending on the country, entity, and customer type.

preferredLocale · string

The preferred locale for the customer, in IETF BCP 47 format (e.g., "en-US", "sv-SE").

Example:

"en-US"

contact · object

Contact details for the customer.

Show child attributes

billing · object

Billing details for the customer.

Show child attributes

userIds · string[]

List of user IDs to associate with this customer.

Depending on the user's role they will either be a member of the customer or given access to manage it.

shippingAddress · object

The shipping address for the customer.

This address is used for shipping physical goods to the customer, such as SIM cards or devices. It is also used to pre-fill the address when ordering physical goods.

Show child attributes

metadata · object

A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format.

Show child attributes

Response

200

application/json

Customer updated successfully.

A customer is a billable entity, the person or organization responsible for paying for services.

The customer is the owner of subscribers and subscriptions. Users are associated with a customer, but are not owned by the customer.

customerId · string · required

Unique identifier for the customer.

customerType · enum<string> · required

The type of customer.

Available options: CONSUMER, BUSINESS

name · string · required

Name of the customer.

contact · object · required

Contact details for the customer.

Show child attributes

identity · string

The identity of the entity, such as personal number, organization number, etc., depending on the country, entity, and customer type.

preferredLocale · string · default: en-US

The preferred locale for the customer, in IETF BCP 47 format (e.g., "en-US", "sv-SE").

Example:

"en-US"

humanReadableId · string

A human-readable identifier for the customer that customers can state in support requests.

Example:

"29A-BY3Z-X78"

referenceId · string

A reference identifier provided by API clients to identify this customer in their own systems. Must be unique per tenant. Use this field to look up customers or to create/retrieve customers during order creation.

Maximum string length: 255

Example:

"crm-customer-12345"

billing · object

Billing configuration and payment preferences for the customer.

Show child attributes

users · object[]

List of users associated with this customer.

Show child attributes

contactPerson · object

The primary contact person for the customer.

Show child attributes

shipping · object

The shipping address for the customer.

This address is used for shipping physical goods to the customer, such as SIM cards or devices. It is also used to pre-fill the address when ordering physical goods.

Show child attributes

metadata · object

A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format.

Show child attributes