Contacts

Add/update a contact

The method is used to add a new or update an existing contact. The ID field is ignored.<br>To learn more about importing or updating contacts and their additional fields, read <a href="${v1contact.post.link}">Importing historical data</a>.

post/api/v1/contact

Request

  • Base URL: https://yespo.io (the document declares no server; this is the origin it was published from)
  • URL: https://yespo.io/api/v1/contact
  • Auth: HTTP basic

Request body

firstNamestring

Contact’s first name. The following rules apply to character usage: <br>

  • Max length: 40 symbols. <br>- Letters from any alphabet are allowed (Unicode characters). <br>- Three words longer than 3 characters and three words with a maximum of 3 characters are allowed. <br>- Up to 3 digits are allowed. <br>- Special characters are not allowed, except for: <br>-- Apostrophes ''ʼ`´ʹʻʽʾʿˈˊˮʹ΄՚᾽᾿'‛′‵Ꞌꞌ＇ (only inside words) <br>-- Hyphen - (only inside words) <br>-- One dot at the end of words having max 3 characters. Example: Jr. <br>- Names consisting only of numbers and special characters are not allowed
lastNamestring

Contact’s last name. The following rules apply to character usage: <br>

  • Max length: 40 symbols. <br>- Letters from any alphabet are allowed (Unicode characters). <br>- Three words longer than 3 characters and three words with a maximum of 3 characters are allowed. <br>- Up to 3 digits are allowed. <br>- Special characters are not allowed, except for: <br>-- Apostrophes ''ʼ`´ʹʻʽʾʿˈˊˮʹ΄՚᾽᾿'‛′‵Ꞌꞌ＇ (only inside words) <br>-- Hyphen - (only inside words) <br>-- One dot at the end of words having max 3 characters. Example: Jr. <br>- Names consisting only of numbers and special characters are not allowed
addressBookIdinteger

You can get the info about catalogs using the <i>/v1/addressbooks GET</i> method

idinteger

Contact ID

externalCustomerIdstring

External contact id

contactKeystring

Contact's key

languageCodestring

Language code for the contact

timeZonestring

The contact's time zone. See <a href='https://en.wikipedia.org/wiki/List_of_tz_database_time_zones'>TZ database name</a>.

marketIdstring

Market ID. Optional parameter. Up to 64 characters. Allowed: [a–zA-Z0–9-_]

Example request

{
  "firstName": "John",
  "lastName": "Smith",
  "channels": [
    {
      "device": {
        "appId": "83b77a49-fc28-409b-aeaa-68c9d544ab9d",
        "deviceModel": "[\"iPhone 16 Pro\",\"Samsung Galaxy S24 Ultra\"]",
        "os": "[\"iOS\",\"Android\"]",
        "locale": "[\"en_UK\",\"ua_UA\"]",
        "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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.