POST /contacts/v1/addresses/email/search

Overview

Retrieves the contact key for one or more email channel addresses.

JSON Parameters

Name Type Description
channelAddressList array Required List of email channel addresses for which a contact key is requested
maximumCount integer Number of contact keys associated with an email channel address. The default value is 1.

Usage

Example Request

Host: https://YOUR_SUBDOMAIN.rest.marketingcloudapis.com
POST /contacts/v1/addresses/email/search 
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

{ 
    "ChannelAddressList":["email@example.com"],
    "MaximumCount":1
}

Example Response

{
  "channelAddressResponseEntities": [
    {
      "contactKeyDetails": [
        {
          "contactKey": "12345@example.com",
          "createDate": "2014-11-15T11:51:00"
        }
      ],
      "channelAddress": "email@example.com"
    }
  ],
  "requestServiceMessageID": "unique-UUID-provided-by-SFMC",
  "resultMessages": [],
  "serviceMessageID": "unique-UUID-provided-by-SFMC"
}
Last Updated: Jun 8, 2021