Overview

The Account Contact Attributes Collection contains the universal set of attributes or fields that can be associated with contact profiles.

• API Set Name: accountcontactattributes

Additional information

• The possible data types for attributes are:
• string: can be any string.
• number: must be a number.
• date: must be a date. Date format is "ISO 8601" standard.
• geo: this is actually an object that contains address fields as well as a coordinate set. It is automatically indexed.
• array: an array of one or more values.
• The "cart" attribute type comes included as part of the contact data schema. There is no need to add a cart attribute for storing cart item data.  Learn more in the contacts API article.
• Attributes may be added at any time to your database and are immediately available to all contacts once created.
• Attributes must already exist before contact data containing those attributes can be added.
• Attribute names must be unique.
• Attributes can be optionally indexed.
• If the data is strictly used for personalization, there is no need for it to be indexed.
• If the field will be used in an audience builder query, it should be indexed.

Resource associations

The following resource collections are associated to this collection.

Methods, parameters, and examples

POST /accountcontactattributes

Parameters

* Required

Example JSON requests

String: The following will create an indexed string contact attribute called "first_name".

{
 "name": "First Name",
 "key": "first_name",
 "type": "string",
 "index": true
}

Number: The following will create an indexed numeric contact attribute called "points" that is required and has a maximum value of 250.

{
 "name": "Points",
 "key": "points",
 "type": "number",
 "index": true,
 "validators": {
 "min": 0,
 "max": 250,
 "required": true
 }
}

Date: The following will create an indexed date contact attribute called "bday".

{
 "name": "Birthday",
 "key": "bday",
 "type": "date",
 "index": true
}

Geo: The following will create an indexed geo contact attribute called "home_address".

{
 "name": "Home Address",
 "key": "home_address",
 "type": "geo",
 "index": true
}

Array: The following will create an indexed array contact attribute called "fruits" with a max item count of 5 and min/max allowed characters per item of 1 and 40, respectively.

{
 "name": "Favorite Fruits",
 "key": "fruits",
 "type": "array",
 "index": true,
 "validators": {
 "max": 40,
 "min": 1
 },
 "options": {
 "maxitems": 5
 }
}

Example request URIs

The following URI in conjunction with the JSON will perform the POST.

http://<path>/accountcontactattributes

GET /accountcontactattributes

Example request URIs

The following URI will retrieve all accountcontactattributes.

http://<path>/accountcontactattributes

The following URI will retrieve all accountcontactattributes that have type "string".

http://<path>/accountcontactattributes?type=string

The following URI will retrieve all accountcontactattributes that have type "number" and are being indexed.

http://<path>/accountcontactattributes?type=number&indexed=1

GET /accountcontactattributes/{key}

Example request URIs

The following URI will retrieve the accountcontactattribute with the key value of "first_name".

http://<path>/accountcontactattributes/first_name

PUT /accountcontactattributes/{key}

Parameters

See parameters for the POST method above. No parameters are required.

Example JSON requests

The following will update the account contact attribute name to "first", and will change the field to be indexed.

{
 "name": "first",
 "index": true
}

Example request URIs

The following URI in conjunction with the JSON will perform the POST.

http://<path>/accountcontactattributes/first_name

DELETE /accountcontactattributes/{key}

Example request URIs

The following URI will delete the accountcontactattribute with the key value of "points".

http://<path>/accountcontactattributes/points

Error responses

The Cordial API will return an error object with an errorKey and message if there is a problem with an API call. Below is a list of errors specific to the Account Contact Attributes API endpoint, along with suggested modifications to resolve each error. If you receive an error from this API endpoint that is not listed in this table, it is likely recorded within the Global API Error Responses page.