Skip to main content

Documentation Index

Fetch the complete documentation index at: https://qomon-86428773.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Contact object:

A contact represents an individual and is defined by two types of fields:

​
Basic fields:

These are simple key-value pairs that define essential information about the contact, such as: 
{
  "firstname": "John",
  "surname": "Doe",
  "mail": "john.doe@example.com",
  "mobile": "0123456789",
  "address": {
    "housenumber": "123",
    "street": "Rue de la paix",
    "city": "Paris",
    "country": "France"
  },
  "tags": ["important", "vip"]
}

​
Advanced fields:

Information like consents, surveys, custom fields, presence status, level of support and tasks are stored in advanced fields. For contact upsert, these fields are represented as lists of objects where you specify either the label or id of the form along with the value of the field. For free-text fields, such as some survey forms, you can directly provide the answer value. However, for others, like consents, you must provide the exact value of the corresponding refvalue (e.g., consent_email). 
{
  "status": [
    { "label": "Level of support", "value": "active" }
  ],
  "forms": [
    { "label": "Survey question", "value": "Answer value" }
  ],
  "custom_fields": [
    { "label": "Job", "value": "Architect" }
  ],
  "actions": [
    { "id": 2314, "value": "send_information" }
  ]
}
Mapping between fields name and technical label:
  • consents: consents
  • level of support: status
  • survey: forms
  • custom fields: custom_fields
  • tasks: actions
When retrieving contacts, advanced fields are formatted as formdatas structure with form_id and form_ref_id. See the /forms/{id} endpoint for more details.

​
Tips for using the API:

  • Upserting Contacts:
    For creating or updating contacts, we recommend using the asynchronous POST /contacts/upsert route. This route simplifies the process by letting you work with labels or IDs directly without needing to understand the underlying formdatas structure.
  • Retrieving Contact Details:
    When fetching a contact, advanced fields like consents or surveys will appear in the formdatas structure. Use the forms endpoints (e.g., GET /forms/{id}) to decode and interpret these references.
Last modified on May 20, 2026