Update or create a contact (upsert) | Solvimon

curl -X PUT https://test.api.solvimon.com/v1/contacts \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "reference": "contact_202406",
  "customer_id": "cust_78910",
  "email": "jane.doe@example.com",
  "custom_fields": [
    {
      "reference": "preferred_language",
      "value": "English"
    }
  ]
}'

{
  "reference": "contact_202406",
  "customer_id": "cust_78910",
  "email": "jane.doe@example.com",
  "object_type": "CONTACT",
  "id": "c1234567-89ab-4def-0123-456789abcdef",
  "name": {
    "first_name": "Jane",
    "last_name": "Doe",
    "infix": "van"
  },
  "notification_preferences": [
    {
      "type": "INVOICE",
      "channels": [
        {
          "type": "EMAIL",
          "enabled": true
        }
      ]
    }
  ],
  "custom_fields": [
    {
      "id": "cf_001234",
      "reference": "preferred_language",
      "value": "English",
      "values": [
        "English",
        "Spanish"
      ],
      "integration_details": {
        "payment_gateway_variant": "ADYEN",
        "id": "int_98765",
        "reference": "int_ref_001",
        "adyen": {
          "recurring_detail_reference": "recurring_adyen_12345"
        },
        "stripe": {
          "payment_method_id": "pm_1GqIC8Lz0qyl6XeWz7aXbY2Z"
        }
      }
    }
  ],
  "linked_integrations": [
    {
      "id": "int_98765",
      "link_details": [
        {
          "url": "https://integration.example.com/profile/janedoe",
          "custom_field_name": "profile_link"
        }
      ]
    }
  ]
}

Requires the CONTACT.CREATE or CONTACT.UPDATE permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

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

Path parameters

versionstringRequiredDefaults to 1

version

Query parameters

identifier_fieldstringOptional

Which field to use to identify whether the resource exists or not

custom_field_referencestringOptional

Which custom field to use to identify whether the resource exists or not

field_actionsmap from strings to stringsOptional

The list of actions for specific fields.

Request

This endpoint expects an object.

referencestringRequiredformat: "^\S+$"0-256 characters

A custom reference assigned to the contact.

customer_idstringRequired

The ID of the customer.

emailstringRequiredformat: "(\S*@\S*\..*)"0-256 characters

The email of the contact.

nameobject or nullOptional

A custom name assigned to the contact.

notification_preferenceslist of objects or nullOptional

Notification preferences for contact-related communications.

custom_fieldslist of objects or nullOptional

linked_integrationslist of objects or nullOptional

Response

Created

referencestringformat: "^\S+$"0-256 characters

A custom reference assigned to the contact.

customer_idstring

The ID of the customer.

emailstringformat: "(\S*@\S*\..*)"0-256 characters

The email of the contact.

object_typestring or nullRead-only

idstring or nullRead-only

nameobject or null

A custom name assigned to the contact.

notification_preferenceslist of objects or null

Notification preferences for contact-related communications.

custom_fieldslist of objects or null

linked_integrationslist of objects or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error