Add/Update Contact

Utilisez ceci lorsqu'un client a plus d'une personne qui doit recevoir des textos et des courriels, comme un propriétaire et un comptable.


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


Point de terminaison

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

Demande
Champ
Type
Description
_id
String
L'identifiant que nous attribuons à ce contact. Omettez-le lors de la création d'un contact et envoyez-le lors de la mise à jour d'un contact.
externalId
String
Votre propre identifiant pour ce contact, provenant de votre logiciel. Envoyez à nouveau le même externalId pour mettre à jour ce contact au lieu d'en ajouter un nouveau. Nous faisons la correspondance sur cette valeur, mais nous n'empêchons pas les doublons; gardez-la donc unique au sein du site.
firstName
String
Le prénom du contact.
lastName
String
Le nom de famille du contact.
displayName
String
Le nom qui sera affiché pour le contact. S'il est laissé vide, il sera par défaut le prénom et le nom de famille.
language
String
La langue préférée pour le contact. Utilise les codes de langue ISO 639-1.
Default = en
emails
Une liste d'adresses courriel pour le contact.
phoneNumbers
Une liste de numéros de téléphone pour le contact.
addresses
Une liste d'adresses pour le contact.
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"
      }
    }
  ]
}


		
Réponse
Champ
Type
Description
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 moment précis en format ISO 8601, avec un fuseau horaire. 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"
}


		

Voir aussi