Fully update (REPLACE) an existing contact by id synchronously.

Update entirely an existing contact by id synchronously in the Qomon database (behaves like PUT). Fully replace an existing contact in the Qomon database.

⚠️ Important:

• This endpoint uses the PATCH verb but behaves like a PUT (full replacement).
• Any fields that are NOT included in the payload will be cleared/removed.
• Always send the full contact object if you don’t want to lose existing data.

To synchronize and mass update your contacts with Qomon database, use the UPSERT route instead.

To specify the advanced fields (survey, consents, etc), you need to use the formdatas structure with form_id and form_ref_id.

• form_id: the ID of the advanced field
• form_ref_id: the ID of the value of the advanced field
• data: free text if the field (“forms”) type is Text, Integer, or Date (input format: YYYY-MM-DD'T'HH:mm:ss.SSS'Z'; responses may return up to microsecond precision: YYYY-MM-DD'T'HH:mm:ss.SSSSSS'Z'); otherwise, use the value of the refvalue
• date: the date of the formdata entry

"formdatas": [
  {
    "form_id": 47566,
    "form_ref_id": 15648,
    "data": "consent_email"
  }
]

To specify the custom fields, you need to use the custom_fields structure with form_id and form_ref_id.

• form_id: the ID of the custom field
• form_ref_id: the ID of the value of the custom field
• data: free text if the field (“forms”) type is Text, Integer, or Date (input format: YYYY-MM-DD'T'HH:mm:ss.SSS'Z'; responses may return up to microsecond precision: YYYY-MM-DD'T'HH:mm:ss.SSSSSS'Z'); otherwise, use the value of the refvalue
• date: the date of the custom_field entry

"custom_fields": [
  {
    "form_id": 879854,
    "form_ref_id": 98741,
    "data": "hamburger",
    "date": "2024-07-17T11:34:42.195Z"
  }
]

NB :

• Each patch will generate new ids for formdatas and custom_fields. (due to the full replace behavior : soft delete + recreate)
• If you don’t send the exhaustive list of formdatas or custom_fields, the missing ones will be deleted (soft).
• For Text, Integer and Date Fields, If you add a formdata or custom_field, it will be added to the existing ones.
• For Radio (single select), If you add a formdata or custom_field, it will replace the existing ones.
• For Checkbox (multi-select) fields, any new value will be added to the existing ones.
• If you change a formdata or custom_field with, it will update it. (the id is not required here because of the full-replace behavior).

PATCH /contacts/{contactId}

Error

A valid request URL is required to generate request examples

200

{
  "status": "success",
  "data": {
    "contact": {
      "id": 12345678,
      "group_id": 1,
      "CreatedAt": "2022-10-13T15:50:34.643724Z",
      "UpdatedAt": "2022-10-13T15:55:12.853724Z",
      "lastchange": "2022-10-13T15:50:24.163Z",
      "firstname": "Jeanne",
      "surname": "Dupont",
      "married_name": "Dupont",
      "gender": "F",
      "birthdate": "1955-07-06T00:00:00Z",
      "age_category": 123,
      "birthdept": "<string>",
      "birthcity": "<string>",
      "birthcountry": "<string>",
      "nationality": "<string>",
      "mail": "[e-mail]",
      "phone": "<string>",
      "mobile": "<string>",
      "address": {
        "housenumber": 1,
        "street": "rue de la paix",
        "postalcode": 75000,
        "citycode": 75101,
        "city": "Paris",
        "state": "Ile-de-France",
        "country": "France",
        "addition": "Résidence de la paix",
        "infos": "Porte de gauche",
        "building": "Bâtiment A",
        "floor": 2,
        "door": "A",
        "pollingstation": "BV-06",
        "id": 1001,
        "score": 0.965753,
        "latitude": "48.000000",
        "longitude": "2.000000",
        "location": "48.000000,2.000000",
        "invalid": null
      },
      "tags": [
        {
          "name": "<string>",
          "appearance_count": 123,
          "color": "<string>"
        }
      ],
      "actions_ids": [
        123
      ],
      "user_id": 123,
      "user_contact_id": 123,
      "formdatas": [
        {
          "form_id": 1001,
          "form_ref_id": 2001,
          "data": "Oui",
          "id": 3001,
          "created_at": "2022-10-13T15:50:24.163Z",
          "updated_at": "2022-10-13T15:50:24.163Z",
          "deleted_at": "2022-10-13T15:50:24.163Z",
          "date": "2022-10-13T15:50:24.163Z",
          "donedate": null,
          "label": null,
          "type_of_form": null,
          "group_id": 1,
          "contact_id": 12345678
        }
      ],
      "customfields": [
        {
          "form_id": 1001,
          "form_ref_id": 2001,
          "data": "Oui",
          "id": 3001,
          "created_at": "2022-10-13T15:50:24.163Z",
          "updated_at": "2022-10-13T15:50:24.163Z",
          "deleted_at": "2022-10-13T15:50:24.163Z",
          "date": "2022-10-13T15:50:24.163Z",
          "donedate": null,
          "label": null,
          "type_of_form": null,
          "group_id": 1,
          "contact_id": 12345678
        }
      ],
      "black_list": true,
      "notes": [
        {
          "content": "<string>",
          "id": 123,
          "pinned": true
        }
      ]
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

contactId · integer · required

ID of contact to update

Body

application/json

The new values of the contact

data · object

Show child attributes

Response

200

application/json

Successful operation

status · string

Example:

"success"

data · object

Show child attributes