Add/Update Contact

Usa esto cuando un cliente tiene más de una persona que debe recibir mensajes de texto y correos electrónicos, como un propietario y un contador.


The following endpoint can be used to add or update a contact within the Hyfin application.


Punto Final

The following endpoint can be used to add or update a contact. You must replace the {base_url} and {site_id} variable with the id of the customer that this contact belongs to.

POST
{base_url}/api/v4/site/{site_id}/contact/addUpdate

Solicitud
Campo
Tipo
Descripción
_id
String
El id que asignamos a este contacto. Omítelo al crear un contacto y envíalo al actualizar uno.
externalId
String
Tu propio id para este contacto, desde tu software. Envía de nuevo el mismo externalId para actualizar este contacto en lugar de agregar uno nuevo. Usamos este valor para hacer la coincidencia, pero no evitamos duplicados, así que manténgalo único dentro del sitio.
firstName
String
El primer nombre del contacto.
lastName
String
El apellido del contacto.
displayName
String
El nombre que se mostrará para el contacto. Si se deja en blanco, se establecerá por defecto el nombre y apellido.
language
String
El idioma preferido para el contacto. Utiliza códigos de idioma ISO 639-1.
Default = en
emails
Una lista de direcciones de correo electrónico para el contacto.
phoneNumbers
Una lista de números de teléfono para el contacto.
addresses
Una lista de direcciones para el contacto.
Sample Request (Add a Contact)
			
{
  "externalId": "58810342",
  "firstName": "John",
  "lastName": "Doe",
  "displayName": "John Doe",
  "language": "en",
  "emails": [
    {
      "label": "work",
      "address": "johndoe@abc.com",
      "isPrimary": true
    }
  ],
  "phoneNumbers": [
    {
      "label": "mobile",
      "number": "333-444-5555",
      "isPrimary": true
    }
  ],
  "addresses": [
    {
      "label": "billing",
      "isPrimary": true,
      "address": {
        "addressLine1": "123 Main Street",
        "addressLine2": "Suite 123",
        "city": "Naples",
        "stateCode": "FL",
        "zipCode": "34102"
      }
    }
  ]
}


		
Respuesta
Campo
Tipo
Descripción
success
Boolean
Whether the record was added or updated successfully.
action
String
Informs whether the record was added or updated. Will only be returned if success is true.
One of added, updated
_id
String
The id we assign to the record.
updatedAt
The date the record was last updated. Un momento en el tiempo en formato ISO 8601, con zona horaria. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
errors
String [ ]
A list of errors. Will only be returned if success is false.
			
{
  "success": true,
  "action": "added",
  "_id": "60f720d248f143332af022e0",
  "updatedAt": "2025-05-30T19:19:44.143Z"
}


		

Ver también