Attribute Keys (contact)

Request

curl -X GET 'https://app.mailyte.com/api/v1/contacts/attribute-keys' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'

const response = await fetch('https://app.mailyte.com/api/v1/contacts/attribute-keys', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
  },
});
const { data } = await response.json();

import requests
response = requests.get(
    "https://app.mailyte.com/api/v1/contacts/attribute-keys",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->get('https://app.mailyte.com/api/v1/contacts/attribute-keys');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/contacts/attribute-keys")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

Response

Success.

• dataarray<object>
  • objectstringcontact_field
  • idstring

    The definition's id, for PUT/DELETE /contact-fields/{field}. null when declared is false — there is no definition row, so there is nothing to address.

  • keystring

    The stable name. This is the key inside a contact's fields object and the {{ signup_date }} tag in campaign content. Contact values are keyed by this, never by id.

  • declaredboolean

    Whether this key is defined as a contact field (with a label, type and default), or was only seen on contact data. Both can be used in content and segment rules.

  • labelstring

    Display name. Derived from the key for an undeclared one.

  • typestringtext | number | date | boolean

    How a value should be EDITED and displayed. Not a storage type: every value in a contact's fields object is a string whatever this says, and nothing is coerced.

  • requiredboolean

    Whether every contact must have a value. Checked when a contact is created, and when an update would clear the value; existing contacts are not checked. A default value does not count. Always false for a key that is not defined.

  • default_valuestring

    Substituted at send time for contacts with no value of their own. It is never written into a contact's fields.

  • help_textstring

    The hint shown beside this field on a form. null MEANS NONE WAS WRITTEN — it carries no behaviour, so an absent hint changes nothing about what the field accepts.

  • contacts_with_valueinteger

    How many contacts carry a non-empty value for this key — the "is it safe to delete this" signal. Always an integer.

  • created_atstring

    null when declared is false: an observed key has no definition row and therefore no creation time. Genuinely unknown, not zero.

Returned inside the standard envelope.

Errors

Every status, with what causes it and what to do, is on the error reference.