Contacts

API Set Name: contacts

• GET /contacts
• POST /contacts
• DELETE /contacts/{primary_key}
• GET /contacts/{primary_key}
• PUT /contacts/{primary_key}
• PUT /contacts/{primary_key}/unsubscribe/{channel}
• DELETE /contacts/{primary_key}/cart
• POST /contacts/{primary_key}/cart
• PUT /contacts/{primary_key}/cart
• POST /contacts/{primary_key}/cartitems
• DELETE /contacts/{primary_key}/cartitems/{productID}
• DELETE /contacts/{primary_key}/cartitems/{productID}/{qty}
• POST /contacts/{primary_key}/downloadprofile

API Description and Functional Purpose:

The contacts collection contains all contacts and their associated attribute, list and channel data.

Additional information:

• A contact is unique based on email address (also referred to as primary_key). By default Cordial uses channels.email.address as the primary key.
• A contact can have multiple attribute key/value pairs such as First Name, Last Name, etc. provided an attribute has been previously defined within the account contact attributes collection.
• A contact can be associated to one or more lists, stored in the contact collection as an array of key/value pairs.
• Validators assigned to each attribute are enforced when attribute data is added or updated within the contact collection.
• Validators changed after data is added will not affect existing saved data nor will they force revalidation. However, edits to that data may.
• Contact activity data resides in the contact activities collection and is associated back to the contact via its primary key, currently the email address.

Resource Associations:

The following resource collections are associated to this collection.

GET /contacts

Parameters

Example GET Request URIs

Retrieve All Contacts

The following URI will retrieve all contacts and include all account contact attributes fields:

http://<path>/contacts

Filter Results By Email

The following URI will retrieve a contact and its associated account contact attributes where the email is "msmith@example.com":

http://<path>/contacts?email=msmith@example.com

Filter Results By cID

The following URI will retrieve a contact and its associated account contact attributes where the cID is "58d2fc99ac0c8117814d4e78":

http://<path>/contacts/58d2fc99ac0c8117814d4e78?isCID=true

Filter Response By Audience Key

The following URI will retrieve contacts within the audience with a key of "clicked".

http://<path>/contacts?audience-key=clicked

Filter Response By Attribute Key

The following URI will retrieve all contacts where the value for the contact attribute gender is "male".

http://<path>/contacts?gender=male

Page Request Parameters

The following URI will retrieve all contacts starting from the third page grouping contacts by 10. For example, page 1 would have included the first 10, page 2 the second group of 10 and so on.

http://<path>/contacts?page=3&per_page=10

Return Count

The following URI will retrieve a count of all contacts in the request:

http://<path>/contacts?return_count=true

Note: Get /contacts can process a maximum of 10k contacts. For example, a request for 1k contact records per page will return contact records for pages 1 through 10 but it will not return records on the 11th page. If it is necessary to access more that 10k contact records, the contactexport api call should be used.

POST /contacts

Parameters

* Required

Note: Cordial is designed as a multi-channel messaging platform. Email is the default channel, where address is required. channels.email.address acts as the primary key for each contact by default. With a custom configuration to your account, it is possible to alternatively use a contact attribute value as the primary key.

Example JSON Request (minimum requirements)

The following will create a new contact with the email "msmith@example.com".

{
	"channels": {
		"email": {
			"address": "msmith@example.com"
		}
	}
}

Example JSON Request (with subscribe status, contact attributes and list assignment)

The following will create a new contact for the email msmith@example.com with contact attribute values (first_name, last_name, age, location.postal_code) and list assignments (auto-enthusiast and safe-driver). Note that the contact attribute keys and list keys were created prior to the POST /contacts using the POST /accountcontactattributes and POST /accountlists API calls.

{
	"channels": {
		"email": {
			"address": "msmith@example.com",
			"subscribeStatus": "subscribed"
		}
	},
	"first_name": "Mark",
	"last_name": "Smith",
	"location.postal_code": "92613",
	"age": 32,
	"auto-enthusiast": true,
	"safe-driver": true
}

Note:

• If subscribe status is not set, it will default to "none". Other available options are "subscribed" and "unsubscribed".
• Contact attributes must already exist in the system to add their values. Contact attributes can be added using the POST /accountcontactattributes API call.
• Lists must already exist in the system to add their assignment. Lists can be added using the POST /accountlists API call.
• List assignment is determined by a boolean value, "true" or "false".
• "location.postal_code" is a geo attribute where the key is "location".
• Geo attributes contain the following set schema of key names:
  • street_address
  • street_address2
  • city
  • state
  • postal_code
  • country
  • tz (time zone)
  • loc
    • lat (latitude)
    • lon (longitude)

Example JSON Request (resubscribing a contact)

The following will resubscribe a contact and override the previously set unsubscribe flag. It will also set the invalid flag to false.

Note: Setting the invalid flag to false will override a hard bounced email address.

{
	"channels": {
		"email": {
			"address": "msmith@example.com",
			"subscribeStatus": "subscribed",
			"invalid": false
		}
	},
	"forceSubscribe": true
}

Example POST Request URI

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

http://<path>/contacts

DELETE /contacts/{primary_key}

Example DELETE Request URI

The following URI will delete a contact and its associated account attribute values with the primary key value of "msmith@example.com".

http://<path>/contacts/msmith@example.com

GET /contacts/{primary_key}

Example GET Request URI

The following URI will retrieve a contact and its associated account attributes values with the primary key value of "msmith@example.com".

http://<path>/contacts/msmith@example.com

PUT /contacts/{primary_key}

Parameters

See the parameters for POST /contacts above.

Example JSON Requests

Update a String Attribute

The following will update the contact's first_name string attribute to "Markus".

{
  "first_name": "Markus"
}

Update an Number Value

The following will update the contact's points number attribute to 75.

{
  "points":75
}

The following will increment the contact's points number attribute by 15.

{
	"points": {
		"inc": 15
	}
}

The following will decrement the contact's points number attribute by 15.

{
	"points": {
		"inc": -15
	}
}

Update an Array Value

The following will update the contact's fav_fruits array attribute with the value "banana". Note that this will overwrite any existing array values.

{
	"fav_fruits": ["banana"]
}

The following will update the contact's fav_fruits array attribute with "banana" and "strawberry". Note this will overwrite existing array values.

{
	"fav_fruits": ["banana", "strawberry"]
}

The following will add the value "apple" to the contact's fav_fruits array attribute. Existing values will be retained unless the max items limit is exceeded (default 25).

{
	"fav_fruits": {
		"add": ["apple"]
	}
}

The following will remove the value "apple" and "strawberry" from the contact's fav_fruits array attribute.

{
	"fav_fruits": {
		"remove": ["apple", "strawberry"]
	}
}

Update List Assignment

The following will update the list assignments of safe-driver and premium-roadside-assistance for the contact. Note that the lists were created prior to updating the contact using the POST /accountlists API call.

{
	"safe-driver": false,
	"premium-roadside-assistance": true
}

Update Email Address

The following will update the email address for the contact.

{
	"channels": {
		"email": {
			"address": "markussmith@example.com"
		}
	}
}

Example PUT Request URI

The following URI in conjunction with the JSON will perform the PUT for the contact with the primary key of "msmith@example.com".

http://<path>/contacts/msmith@example.com

PUT /contacts/{primary_key}/unsubscribe/{channel}

Parameters

* Required

Example PUT Request URI

The following URI will set the subscribe status to "unsubscribed" in the "email" channel of the contact with a primary key of "msmith@example.com".

http://<path>/contacts/msmith@example.com/unsubscribe/email

The following URI will unsubscribe the contact and attribute the unsubscribe to a specific message using the mcID.

http://<path>/contacts/msmith@example.com/unsubscribe/email?mcID=252:58ffed51f0c36063476c1752:ot:58d30719ac0c8117814da1f3:1

DELETE /contacts/{primary_key}/cart

Example DELETE Request URI

The following URI will delete the cart object from the contact with a primary key of msmith@example.com.

http://<path>/contacts/msmith@example.com/cart

POST /contacts/{primary_key}/cart

Parameters

* Required

Example JSON Request

{
	"mcID": "264:590261c7f0c360ee35a8046f:ot:5900ddf2ac0c81178189d93b:1",
	"customerID": "1234",
	"linkID": "1234",
	"url": "http:example.com",
	"cartitems": [{
			"productID": "GreenPlaid123123",
			"name": "Green Plaid",
			"sku": "111222333",
			"category": "Shirts",
			"qty": 2,
			"images": ["image1.jpg", "image2.jpg"],
			"itemPrice": 10.99,
			"amount": 21.98,
			"description": "Awesome shirt",
			"url": "http://www.shirts.com/GreenPlaid123123",
			"attr": {
				"size": "small",
				"color": "green"
			},
			"properties": {
				"style": "v-neck",
				"material": "cotton"
			}
		},
		{
			"productID": "BluePlaid123123",
			"name": "Blue Plaid",
			"sku": "111222444",
			"category": "Shirts",
			"qty": 1,
			"itemPrice": 10.99,
			"amount": 10.99,
			"description": "Awesome shirt",
			"url": "http://www.shirts.com/BluePlaid123123",
			"attr": {
				"size": "small",
				"color": "blue"
			},
			"properties": {
				"style": "v-neck",
				"material": "cotton"
			}
		}
	]

}

Example POST Request URI

The following URI in conjunction with the JSON will add the cart object for the contact with the primary key value of "msmith@example.com".

http://<path>/contacts/msmith@example.com/cart

PUT /contacts/{primary_key}/cart

Parameters

See parameters above for POST /contacts/{primary_key}/cart.

Example JSON Request

See example above for POST /contacts/{primary_key}/cart.

Example PUT Request URI

The following URI in conjunction with the JSON will update the cart object for the contact with the primary key of "msmith@example.com".

http://<path>/contacts/msmith@example.com/cart

POST /contacts/{primary_key}/cartitems

Parameters

* Required

Example JSON Request

{
	"productID": "PurplePlaid123123",
	"name": "Green Plaid",
	"sku": "111222333",
	"category": "Shirts",
	"qty": 2,
	"images": ["image1.jpg", "image2.jpg"],
	"itemPrice": 10.99,
	"amount": 21.98,
	"description": "Awesome shirt",
	"url": "http://www.shirts.com/PurplePlaid123123",
	"properties": {
		"size": "large",
		"color": "Purple"
	}
}

Example POST Request URI

The following URI in conjunction with the JSON will add an item to the cart of the contact with the primary key value of "msmith@example.com".

http://<path>/contacts/msmith@example.com/cartitems

DELETE /contacts/{primary_key}/cartitems/{productID}

Example DELETE Request URI

The following URI will delete the cart item with the productID of "PurplePlaid123123" for the contact with the primary key value of "msmith@example.com".

http://<path>/contacts/msmith@example.com/cartitems/PurplePlaid123123

DELETE /contacts/{primary_key}/cartitems/{productID}/{qty}

Example DELETE Request URI

The following URI will delete quantity of "1" from the cart item with the productID of "PurplePlaid123123" for the contact with the primary key value of "msmith@example.com".

http://<path>/contacts/msmith@example.com/cartitems/PurplePlaid123123/1

POST /contacts/{primary_key}/downloadprofile

Parameters

* Required

Example JSON Requests

The following will initiate an export job of a JSON file containing all profile data (including events) of the specified contact, downloadable via the UI on the Jobs page.

{
	"destination": {
		"type": "aws"
	}
}

The following will initiate an export job of a JSON file via SFTP containing all profile data (including events) of the specified contact.

{
	"destination": {
		"type": "sftp",
		"server": "example.com",
		"port": "21",
		"username": "username",
		"password": "password",
		"path": "/"
	}
}

Example Request URIs

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

http://<path>/contacts/{primary_key}/downloadprofile