Update customer phone

PUThttps://carchost.fieldcontrol.com.br/customers/{customerId}/phones/{phoneId}

Updates a phone of the customer.

Requires the X-Api-Key, User-Agent and Content-Type: application/json headers. Limit: 1 request per second (learn more).

Request

Path parameters

customerIdstringrequired

Customer identifier.

phoneIdstringrequired

Phone identifier.

Headers

User-Agentstringrequired

Identification of your application.

Example: MinhaIntegracao/1.0.

Request body

JSON, sent with the Content-Type: application/json header.

numberstringrequired

Number with area code, digits only. Validated according to the country in countryCode.

countryCodestring

Country calling code, digits only. Default 55 (Brazil).

typestringrequired

Phone type.

Accepted values: home, work, mobile.

primaryboolean

Sets it as the customer's primary phone.

Default: false.

whatsappboolean

Whether the number has WhatsApp.

Default: false.

Responses

• 200

  Phone updated.

• 401

  API key missing (Missing API Key) or invalid (Invalid API Key). See Authentication.

• 403

  Account blocked (Account blocked), expired (Account expired) or on a plan that does not allow integration (Account plan not allowed). See Authentication.

• 404

  Resource not found. The response body is empty.

• 422

  Invalid request data (resourceValidationErr).

• 429

  Limit of 1 request per second exceeded. See Rate limit.

• 500

  Unexpected server error.