GET api/contacts/{id}/contactsubscriptionstatuses

Get a ContactSubscriptionStatus record by the associated Contact id (CrmNumber).

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The primary key of the parent contact record in the Hobsons database.

 integer

Required

Body Parameters

None.

Response Information

Resource Description

ContactSubscriptionStatusDto
NameDescriptionTypeAdditional information
CrmNumber

A reference to the primary key of the Contact record that is associated with the record. Ignored for PUT (except bulk updates) requests sent to the API.

 integer

None.
SubscribedToDirectEmails

Indicates the contacts current subscription status for direct (non-broadcast) email communications (i.e. whether the contact is opted in or has opted out).

 boolean

Required
SubscribedToDirectPhoneCalls

Indicates the contacts current subscription status for direct (non-broadcast) phone communications (i.e. whether the contact is opted in or has opted out).

 boolean

Required
SubscribedToDirectSms

Indicates the contacts current subscription status for direct (non-broadcast) SMS communications (i.e. whether the contact is opted in or has opted out).

 boolean

Required

Response Formats

application/json, text/json

Sample: 
{
  "CrmNumber": 1,
  "SubscribedToDirectEmails": true,
  "SubscribedToDirectPhoneCalls": true,
  "SubscribedToDirectSms": true
}