Subscribers

List subscriber attributes

Changed on

Lists the custom attribute names in use across the account, so you can reuse existing names and value types when creating or updating subscribers. Value types and examples come from up to 100 recent contacts with custom attributes. Names that only older contacts carry come from the account-wide attribute index, which returns up to the 500 most widely used names, and are included with sampledContacts 0 and the type of their indexed example (a boolean is reported for an example of "true" or "false"). Reserved profile fields (email, first and last name) and internal attributes are not listed. Requires subscribers:read.

get/subscribers/attributes

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/subscribers/attributes
  • Auth
    HTTP bearer

Query parameters

includeNested'true' | 'false'

Also list nested paths such as profile.tier. Must be true or false. Defaults to false.

Response

Attributes in use across the account

successboolean required
sampledContactsinteger required

Recent contacts with custom attributes that were sampled.

Example response

{
  "success": true,
  "attributes": [
    {
      "key": "zip",
      "valueType": "string",
      "sampleValue": "02134",
      "sampledContacts": 42
    }
  ],
  "sampledContacts": 100
}

Changes