Skip to main content

Contact

Payloads for available contact events

Contact Created​

The contact-created event is triggered when a new contact is created.

Payload example​

{
  "id": "CONT-c1496051-94fb-44bb-b68f-2da8f5900e21",
  "customerId": "CUST-e3115ba6-0cce-4ba5-9803-aadf90ba2a96",
  "companyId": "COMP-ebf7b5c3-b50c-43a0-9d01-7ef5c25612ac",
  "firstName": "John",
  "lastName": "Doe",
  "status": "ACTIVE",
  "addressDetails": {
    "address": "123 Example Street",
    "city": "Example City",
    "zipCode": "12345",
    "country": "Example Country"
  },
  "phoneNumbers": [
    {
      "type": "PRIVATE",
      "number": "123-456-7890"
    }
  ],
  "emails": [
    {
      "type": "WORK",
      "mail": "[email protected]"
    }
  ],
  "tags": ["tag1", "tag2"]
}

Contact Updated​

The contact-updated event is triggered when changes are made to an existing contact.

Payload example​

{
  "id": "CONT-c1496051-94fb-44bb-b68f-2da8f5900e21",
  "customerId": "CUST-e3115ba6-0cce-4ba5-9803-aadf90ba2a96",
  "companyId": "COMP-ebf7b5c3-b50c-43a0-9d01-7ef5c25612ac",
  "firstName": "John",
  "lastName": "Doe",
  "status": "ACTIVE",
  "addressDetails": {
    "address": "123 Example Street",
    "city": "Example City",
    "zipCode": "12345",
    "country": "Example Country"
  },
  "phoneNumbers": [
    {
      "type": "PRIVATE",
      "number": "123-456-7890"
    }
  ],
  "emails": [
    {
      "type": "WORK",
      "mail": "[email protected]"
    }
  ],
  "accountDetails": {
    "position": "Manager"
  },
  "tags": ["tag1", "tag2"]
}

Contact Deleted​

The contact-deleted event is triggered when a contact is removed.

Payload example​

{
  "id": "CONT-c1496051-94fb-44bb-b68f-2da8f5900e21",
  "customerId": "CUST-e3115ba6-0cce-4ba5-9803-aadf90ba2a96",
  "emails": [
    {
      "type": "WORK",
      "mail": "[email protected]"
    }
  ]
}