Consent
Consent is required in order to interact with customers via the communication channels; call, email, or letter. This includes but is not limited to, the sending of Campaigns for products of interest.
Communication channels
call
email
letter
sms
- This communication channel has not yet been fully intergrated into EASI'R
When consent status is updated
- The customer provides the consent via Lead
- The customer unsubscribes from a Campaign
- A user updates the consent preferences upon receipt from the customer (assumes Edit Consent permissions).
- By API call (described below)
A log of the changes to any contact’s consent can be obtained via the API.
Consent status
true
Customer provides consent for communication channelfalse
Customer does not provide consent for communication channelnull
- Customer has not been asked. (default)
Consent types
user
- Set by usercampaign
- Set by the campaign
Timeline events**
The following timeline events are added to a contact during the consent process:
consent_failed
- The consent email could not be deliveredconsent_created
- Consent was updated
Custom Consent
Unsubscribe links
With custom unsubscribe links, you will be responsible for creating and maintaining a web application that will update the consent status of the contact in EASI'R using the EASI'R API. This will allow you to show your own confirmation page. The URL will have this static list of query string parameters appended to it.
language
salutation
first_name
last_name
campaign_id
contact_id
account_id
This will provide the neccessary IDs to perform a manual consent change with our API (see Set consent section), as well as the ability to display the contact's name on the web page. Custom fields can also be added. For example, if an external reference to a contact is stored as a custom field in EASI'R, this could be used to update the consent status of the contact in third-party systems.
Get consent log
GET /accounts/:accountId/contacts/:contactId/consent
In this example, the latest, and currently valid, consent is displayed at the top. On 03/30, a user updated the consent for the user by the API, and on 03/31 the consent was set by the contact from a consent link in an email.
Response
Status code 200
{
"data": [
{
"type": "email",
"status": true,
"updated_at": "2018-02-01 10:00:20",
"origin": {
"type": "user",
"user": {
"id": 1,
},
"team": null
},
"user_id": 1,
"campaign_id": null,
"contact_id": "8dbb05f9-e19c-34f8-8885-eed4e520bf3c",
"source": "user",
"contact_ip": "33.33.33.1",
"contact_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_4) AppleWebKit/601.5.17 (KHTML, like Gecko) Version/9.1 Safari/601.5.17",
"created_at": "2016-03-31 09:05:26"
},
{
"type": "call",
"status": false,
"updated_at": "2018-02-01 10:00:20",
"origin": {
"type": "user",
"user": {
"id": 1,
"first_name": "Jane",
"last_name": "Doe",
"phone_number": "+4588888888",
"job_title": "Sales Executive",
"email": "demo@easir.com",
"email_notifications": false,
"profile_picture": "https:\/\/randomuser.me\/api\/portraits\/thumb\/women\/5.jpg",
"user_type": {
"id": 5,
"name": "group_admin"
},
"locale": {
"code": "en-US",
"language_name": "English",
"country": {
"name": "United States",
"native_name": "United States",
"code": "US"
}
},
"timezone": {
"name": "Europe\/Copenhagen",
"offset": 3600
},
"system_user": false,
"created_at": "2014-01-01 12:45:56",
"updated_at": "2018-03-12 16:47:47"
},
"team": null
},
"user_id": 1,
"campaign_id": null,
"contact_id": "8dbb05f9-e19c-34f8-8885-eed4e520bf3c",
"source": "user",
"contact_ip": "33.33.33.1",
"contact_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_4) AppleWebKit/601.5.17 (KHTML, like Gecko) Version/9.1 Safari/601.5.17",
"created_at": "2016-03-31 09:05:26"
}
],
"pagination": {
"total": 2,
"page": 1,
"per_page": 15,
"urls": {
"previous": null,
"next": null
}
}
}
Update consent
PUT /accounts/:accountId/contacts/:contactId/consent
Parameters
type
string - The consent type- One of the following:
email
,call
,letter
,sms
- One of the following:
status
bool|null- One of the following:
null
- Has not been been asked (default)false
- Has not given consenttrue
- Has given consent
- One of the following:
Payload
{
"type": "email",
"status": true
}
Response
Status code 200
{
"type": "email",
"status": true,
"updated_at": "2018-02-01 10:00:20",
"origin": {
"type": "user",
"user": {
"id": 1,
"first_name": "Jane",
"last_name": "Doe",
"phone_number": "+4588888888",
"job_title": "Sales Executive",
"email": "demo@easir.com",
"email_notifications": false,
"profile_picture": "https:\/\/randomuser.me\/api\/portraits\/thumb\/women\/5.jpg",
"user_type": {
"id": 5,
"name": "group_admin"
},
"locale": {
"code": "en-US",
"language_name": "English",
"country": {
"name": "United States",
"native_name": "United States",
"code": "US"
}
},
"timezone": {
"name": "Europe\/Copenhagen",
"offset": 3600
},
"system_user": false,
"created_at": "2014-01-01 12:45:56",
"updated_at": "2018-03-12 16:47:47"
},
"team": null
},
"user_id": 1,
"campaign_id": null,
"contact_id": "8dbb05f9-e19c-34f8-8885-eed4e520bf3c",
"source": "user",
"contact_ip": "33.33.33.1",
"contact_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_4) AppleWebKit/601.5.17 (KHTML, like Gecko) Version/9.1 Safari/601.5.17",
"created_at": "2016-03-31 09:05:26"
}