Contacts

Update contact

The method is used to update the contact's data, except for the contact ID field.<br>In case of updating a deleted contact, this contact is restored.

put/api/v1/contact/{id}

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/{id}
  • Auth: HTTP basic

Path parameters

idinteger required

Contact ID

Request body

firstNamestring

Contact's first name

lastNamestring

Contact's last name

addressBookIdinteger

Catalog ID.<br/> You can get the value using the <i>/v1/addressbooks GET</i> method.<br/> Optional parameter.

idinteger

Contact ID

contactKeystring
externalCustomerIdstring
languageCodestring

Language code. Optional parameter.

timeZonestring

Time zone. Optional parameter. 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"
    }
  ],
  "id": 1234567890
}

Changes

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