Tenant API - Content

Match a list of emails to recipients for a specific tenant (v2)

This resource is used to match a list of users to check that they are eligible for receiving Content from the specific Tenant. The request contains a list of recipient email addresses to be matched, and the response is a filtered list containing only the email addresses that are eligible to receive content from the tenant. Email matching is case insensitive, but the queried email case is returned as submitted.

<aside class="notice"> If none of the provided email addresses are eligible to receive content from this tenant, an empty list will be returned. </aside>
post/v2/tenant/{tenantKey}/usermatch/verified_email

Request

  • Base URL: https://sender.api.kivra.com
  • URL: https://sender.api.kivra.com/v2/tenant/{tenantKey}/usermatch/verified_email
  • Auth: oAuth2Client (defined in the document in a form this page cannot read)

Path parameters

tenantKeystring hexadecimal required

The tenant key the matching should be done against. Recipients that opt-out from the tenant will be excluded.

Request body

liststring[] required

list of recipient addresses to be matched

Example request

{
  "list": [
    "fOO@example.com",
    "bAr@EXAMPLE.COM"
  ]
}

Response

Filtered list of email addresses that matched.

liststring[] required

list of recipient addresses to be matched

Example response

{
  "list": [
    "fOO@example.com",
    "bAr@EXAMPLE.COM"
  ]
}

Changes

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