Contact overview

While the contacts API endpoint allows you to check if a contact exists, it does not return any data apart from the contactId (if the contact does exist) or HTTP 404 ContactNotFound (if the contact is not found).

To return the contact's actual data, you will instead need to use the contact overview endpoint:

/api/v2/contactoverview

Using contact overview

A Voyado Engage contactId is a 32-bit GUID with the general form:

33ee9958-0e09-484f-b4c4-aa3e00e1e24

When a contact in your e-commerce platform has a contactId you can use it to get their full details:

GET /api/v2/contactoverview?contactId=33ee9958-0e09-484f-b4c4-aa3e00e1e24c

If you don't have the contactId you can use either of these options (similar to what you do at the contacts endpoint):

email

GET /api/v2/contactoverview?contactType=member&email=jane.doe%40gmail.com

mobilePhone

GET /api/v2/contactoverview?contactType=member&mobilePhone=%2B46702291216

socialSecurityNumber

GET /api/v2/contactoverview?contactType=member&socialSecurityNumber=198506059738

customKey

As the customKey value you can send either a contact's memberNumber or externalId, depending on how your tenant is set up. Your Voyado Engage team can help you here.

GET /api/v2/contactoverview?contactType=member&customKey=999888777

any

The "any" parameter will, as the name suggests, accept any of the above values. They are scanned in the following order: email, socialSecurityNumber, mobilePhone and then customKey.

For example:

GET /api/v2/contactoverview?contactType=member&any=jane.doe%40gmail.com

GET /api/v2/contactoverview?contactType=member&any=999888777

Caution

You must always send the parameter contactType in the query when you call this endpoint.

Response example

{
  "id": "33ee9958-0e09-484f-b4c4-aa3e00e1e24c",
  "attributes": {
    "firstName": "Example",
    "lastName": "Examplesson",
    "street": "Sockenvägen 17",
    "zipCode": "218 32",
    "city": "BUNKEFLOSTRAND",
    "email": "jane.doe@example.com",
    "mobilePhone": "+46702291216",
    "countryCode": "SE",
    "socialSecurityNumber": "198506059738",
    "gender": "Female",
    "careOf": null,
    "country": "Sverige",
    "birthDay": "1982-06-05T00:00:00+02:00",
    "externalId": null,
    "memberNumber": "999888777",
    "rfm": 46,
    "children": [
      "2007-11-28T00:00:00+01:00"
    ],
    "age": 35,
    "registrationDate": "2019-02-05T13:21:02+01:00",
    "bonusPoints": 2481,
    "secrecyMarked": false,
    "currentStore": {
      "id": "0b7037b4-b7f5-4c9d-97e6-aa3b00ccc140",
      "name": "Rotterdam",
      "externalId": "SE014"
    }
  },
  "meta": {
    "createdOn": "2019-04-29T15:42:25+02:00",
    "modifiedOn": "2020-05-31T04:02:27+02:00",
    "sourceType": "Import",
    "approved": true,
    "contactType": "Member",
    "recruitedByStore": {
      "id": "a9573a5a-c9bb-4593-abee-aa3b00ccc141",
      "name": "Nice",
      "externalId": "SE019"
    }
  },
  "preferences": {
    "acceptsEmail": true,
    "acceptsPostal": true,
    "acceptsSms": true
  },
  "memberlevel": {
    "expires": null,
    "levelName": "Bas",
    "remainingToUpgrade": 233,
    "basedOnRewardPoints": 767,
    "levelId": "bas"
  },
  "consents": [
    {
      "id": "consentIntelligentOffers",
      "value": true,
      "date": "2019-05-06T14:00:51+02:00",
      "comment": "",
      "source": "ContactForm"
    },
    {
      "id": "consentSegmentation",
      "value": true,
      "date": "2019-05-06T14:00:51+02:00",
      "comment": "",
      "source": "ContactForm"
    },
    {
      "id": "consentGeneralTerms",
      "value": true,
      "date": "2019-05-06T14:00:51+02:00",
      "comment": "",
      "source": "ContactForm"
    }
  ],
  "audiences": [
    "Best Customers rolling 24 months",
    "My VIP Group",
    "Intergamma VIP",
    "Superbokare"
  ],
  "warnings": [
    "MissingMobileNumber"
  ],
  "bonusChecks": [
    {
      "expiresOn": "2020-08-31T23:59:59+02:00",
      "id": "880adf9c-b70b-47a8-b746-aaf900528332",
      "checkNumber": "0000000000161",
      "name": "Generate reward vouchers 02/11/2019 08:00",
      "value": {
        "currency": "EUR",
        "amount": 3
      },
      "localValues": [
        {
          "currency": "SEK",
          "amount": 30
        },
        {
          "currency": "NOK",
          "amount": 30
        }
      ],
      "bonusPoints": 100,
      "redeemed": false,
      "redeemedOn": null
    }
  ],
  "promotions": [
    {
      "id": "27c03506-89d6-4023-a158-c0bb0dc09e58",
      "externalId": null,
      "type": "Multichannel",
      "name": "Spring Campaign",
      "expiresOn": null,
      "heading": "Spring Campaign",
      "description": "Dear customer, The spring is here, time for updating your wardrobe! Please enjoy the following spring time promotion. With love",
      "redeemed": false,
      "redeemedOn": null,
      "imageUrl": null,
      "link": null,
      "redemptionChannels": [
    {
      "id": "75992b07-b287-4417-8cb8-adba010fdaf8",
      "externalId": null,
      "type": "Multichannel",
      "name": "20% off VIP offer!",
      "expiresOn": null,
      "heading": null,
      "description": null,
      "redeemed": false,
      "redeemedOn": null,
      "imageUrl": null,
      "link": null,
      "redemptionChannels": [
        {
          "type": "POS",
          "valueType": "PERCENT",
          "value": 20,
          "instruction": null
        },
        {
          "type": "ECOM",
          "valueType": "EXTERNALOFFER",
          "value": "VIP20PERCENT",
          "instruction": null
        }
      ]
    }
  ]
}

In this section:

Voyado Engage