v1

latestOpenAPI 3.0.12026-07-24116117186.3 KB

Contacts

Add/update a contact

Creates or updates contacts in real-time. <a href="https://docs.esputnik.com/docs/adding-new-users">Details ></a>.<br/>The guide on bulk contact uploading and updating is available <a href="https://docs.esputnik.com/docs/uploading-file-with-user-profile-data">at the link</a>.<br/><a href="https://docs.esputnik.com/reference/addupdate-a-contact-request-example">Request example</a>.

post/api/v1/contact

Request body

firstNamestring

Contact’s first name. <a href="https://docs.esputnik.com/docs/contact-fields#first-name">Read more...</a>

lastNamestring

Contact’s last name. <a href="https://docs.esputnik.com/docs/contact-fields#last-name">Read more...</a>

addressBookIdinteger

The list of additional contact fields. <a href="https://docs.esputnik.com/reference/getaddressbooks-1">Read more...</a>

idinteger

A field containing the internal contact ID in our system. <a href="https://docs.esputnik.com/docs/contact-fields#contact-id">Read more...</a>

externalCustomerIdstring

A field containing the internal contact ID in your system. <a href="https://docs.esputnik.com/docs/contact-fields#external-id">Read more...</a>

languageCodestring

Language code for the contact. <a href="https://docs.esputnik.com/docs/contact-fields#language">Read more...</a>

timeZonestring

The contact's time zone. <a href="https://docs.esputnik.com/docs/contact-fields#time-zone">Read more...</a>

marketIdstring

Customer market/region identifier. Optional parameter. Up to 64 characters. Allowed symbols: [a-zA-Z0-9-_]

Example request

{
  "firstName": "John",
  "lastName": "Smith",
  "channels": [
    {
      "device": {
        "appId": "83b77a49-fc28-409b-aeaa-68c9d544ab9d",
        "deviceModel": "iPhone 16 Pro",
        "os": "iOS",
        "locale": "en_UK",
        "clientVersion": "1.6.8",
        "appVersion": "1.23.45"
      }
    }
  ],
  "address": {
    "region": "Occitanie",
    "town": "Toulouse",
    "address": "Rue Imaginaire, 456",
    "postcode": "31000",
    "countryCode": "FR"
  },
  "fields": [
    {
      "id": 79814,
      "value": "textfield"
    }
  ],
  "addressBookId": 7200,
  "id": 23456789,
  "externalCustomerId": "TV12790",
  "groups": [
    {
      "id": 200400
    }
  ],
  "languageCode": "en",
  "timeZone": "Europe/London",
  "marketId": "kyiv"
}

All 116 operations