Actualizar un cliente

PUThttps://carchost.fieldcontrol.com.br/customers/{id}

Actualiza un cliente. Envíe el cliente completo: el cuerpo sigue las mismas reglas de la creación.

Requiere los headers X-Api-Key, User-Agent y Content-Type: application/json. Límite: 1 solicitud por segundo (más información).

Solicitud

Parámetros de ruta

idstringobligatorio

Identificador del cliente.

Ejemplo: NTc4NTQ1OjIyOTE1.

Headers

User-Agentstringobligatorio

Identificación de su aplicación.

Ejemplo: MinhaIntegracao/1.0.

Cuerpo de la solicitud

JSON, enviado con el header Content-Type: application/json.

namestringobligatorio

Nombre del cliente. Los textos de más de 120 caracteres se truncan.

Mínimo de 5 caracteres.

codestring

Código del cliente.

Hasta 50 caracteres.Acepta: null.

notesstring

Observaciones del cliente.

Hasta 2000 caracteres.Acepta: null.

documentNumberstring

CPF o CNPJ válido, solo números (sin puntos, guiones ni barras). Debe ser único en la cuenta.

Acepta: null.

externalobject

Campos de external

idstring

Identificador del cliente en su sistema.

Hasta 100 caracteres.Acepta: null.

archivedboolean

Indica si el cliente está archivado.

Predeterminado: false.

addressobjectobligatorio

Dirección del cliente. También se usa para crear la ubicación principal.

Campos de address

zipCodestring

Código postal (CEP) de 8 dígitos, solo números.

Acepta: null.

streetstring

Calle. Los textos de más de 50 caracteres se truncan.

Acepta: null.

numberstring

Número. Los textos de más de 10 caracteres se truncan.

Acepta: null.

neighborhoodstring

Barrio. Los textos de más de 50 caracteres se truncan.

Acepta: null.

complementstring

Complemento. Los textos de más de 50 caracteres se truncan.

Acepta: null.

citystringobligatorio

Ciudad. Los textos de más de 50 caracteres se truncan.

statestringobligatorio

Estado. Los textos de más de 30 caracteres se truncan.

coordsobjectobligatorio

Coordenadas de la dirección. ¿Sin geolocalización? Consulte la guía Servicios de geolocalización.

Campos de coords

latitudenumberobligatorio

De -90 a 90.

longitudenumberobligatorio

De -180 a 180.

Respuestas

• 200

  Cliente actualizado.

• 401

  Clave de API ausente (Missing API Key) o inválida (Invalid API Key). Consulte Autenticación.

• 403

  Cuenta bloqueada (Account blocked), vencida (Account expired) o con un plan que no permite integración (Account plan not allowed). Consulte Autenticación.

• 404

  Recurso no encontrado. El cuerpo de la respuesta está vacío.

• 422

  Cuerpo inválido o documentNumber ya registrado en otro cliente de la cuenta (reason: document number already exists).

  resourceValidationErr →
• 429

  Se superó el límite de 1 solicitud por segundo. Consulte Límite de solicitudes.

• 500

  Error inesperado en el servidor.