Contacts

Contacts management endpoints

Create or update a contact (upsert)

post

https://api.pristo.example.comhttps://sandbox-api.pristo.example.com

/v1/populations/{populationId}/contacts:upsert

Creates a new contact or updates an existing one. Create rule: request must include at least one unique identifier: clientContactId OR phone OR email. Update rule: request should include pristoContactId to update an existing record. Dynamic fields are key/value string pairs (0-255 chars).

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key provided by Pristo (send as header X-API-Key).

Path parameters

populationIdstring · min: 1 · max: 100Required

Population identifier (tenant segmentation / audience container).

Example: pop_123

Body

application/json

firstNamestring · max: 100 · nullableOptional

lastNamestring · max: 100 · nullableOptional

phonestring · nullableOptional

Optional. Can be provided here (in addition to identifiers).

emailstring · email · nullableOptional

Optional. Can be provided here (in addition to identifiers).

languagestring · nullableOptional

ISO 639-1 language code (recommended)

Responses

200

Contact updated

application/json

201

Contact created

application/json

400

Validation error (missing required identifiers, unknown dynamic field, etc.)

application/json

401

Missing or invalid API key

application/json

422

Invalid email or phone

application/json

429

Too many requests

application/json

500

Unexpected error

application/json

post

/v1/populations/{populationId}/contacts:upsert

HTTPcURLJavaScriptPython

POST /v1/populations/{populationId}/contacts:upsert HTTP/1.1
Host: api.pristo.example.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "identifiers": {
    "phone": "[phone]"
  },
  "firstName": "Dana",
  "lastName": "Cohen",
  "language": "he",
  "dynamicFields": {
    "branch": "TLV",
    "customerType": "VIP"
  }
}

Create with phoneUpdate with Pristo contact id

{
  "status": "CREATED",
  "contact": {
    "pristoContactId": "text",
    "populationId": "text",
    "clientContactId": "text",
    "firstName": "text",
    "lastName": "text",
    "phone": "text",
    "email": "text",
    "language": "en",
    "isActive": true,
    "isUnsubscribed": false,
    "dynamicFields": {
      "branch": "TLV",
      "segment": "VIP"
    },
    "createdAt": "2026-02-04T13:56:51.531Z",
    "updatedAt": "2026-02-04T13:56:51.531Z"
  }
}

Set contact active / inactive

post

https://api.pristo.example.comhttps://sandbox-api.pristo.example.com

/v1/populations/{populationId}/contacts:activation

Sets whether a contact is active. Request must include at least one identifier: pristoContactId OR clientContactId.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key provided by Pristo (send as header X-API-Key).

Path parameters

populationIdstring · min: 1 · max: 100Required

Population identifier (tenant segmentation / audience container).

Example: pop_123

Body

application/json

isActivebooleanRequired

Responses

200

Activation updated

application/json

400

Validation error (missing identifiers)

application/json

401

Missing or invalid API key

application/json

404

Contact not found

application/json

429

Too many requests

application/json

500

Unexpected error

application/json

post

/v1/populations/{populationId}/contacts:activation

HTTPcURLJavaScriptPython

POST /v1/populations/{populationId}/contacts:activation HTTP/1.1
Host: api.pristo.example.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "identifiers": {
    "clientContactId": "CRM-889900"
  },
  "isActive": false
}

{
  "contact": {
    "pristoContactId": "text",
    "populationId": "text",
    "clientContactId": "text",
    "firstName": "text",
    "lastName": "text",
    "phone": "text",
    "email": "text",
    "language": "en",
    "isActive": true,
    "isUnsubscribed": false,
    "dynamicFields": {
      "branch": "TLV",
      "segment": "VIP"
    },
    "createdAt": "2026-02-04T13:56:51.531Z",
    "updatedAt": "2026-02-04T13:56:51.531Z"
  },
  "updatedAt": "2026-02-04T13:56:51.531Z"
}

Mark contact as unsubscribed

post

https://api.pristo.example.comhttps://sandbox-api.pristo.example.com

/v1/populations/{populationId}/contacts:unsubscribe

Marks a contact as unsubscribed (opt-out). Request must include at least one identifier: pristoContactId OR clientContactId.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key provided by Pristo (send as header X-API-Key).

Path parameters

populationIdstring · min: 1 · max: 100Required

Population identifier (tenant segmentation / audience container).

Example: pop_123

Body

application/json

Responses

200

Unsubscribe updated

application/json

400

Validation error (missing identifiers)

application/json

401

Missing or invalid API key

application/json

404

Contact not found

application/json

429

Too many requests

application/json

500

Unexpected error

application/json

post

/v1/populations/{populationId}/contacts:unsubscribe

HTTPcURLJavaScriptPython

POST /v1/populations/{populationId}/contacts:unsubscribe HTTP/1.1
Host: api.pristo.example.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "identifiers": {
    "pristoContactId": "c_01HZZZ8J2Q4K5M6N7P8Q9R"
  }
}

{
  "contact": {
    "pristoContactId": "text",
    "populationId": "text",
    "clientContactId": "text",
    "firstName": "text",
    "lastName": "text",
    "phone": "text",
    "email": "text",
    "language": "en",
    "isActive": true,
    "isUnsubscribed": false,
    "dynamicFields": {
      "branch": "TLV",
      "segment": "VIP"
    },
    "createdAt": "2026-02-04T13:56:51.531Z",
    "updatedAt": "2026-02-04T13:56:51.531Z"
  },
  "updatedAt": "2026-02-04T13:56:51.531Z"
}