Consents

Get Consents

get /consents

Returns a list of consents available when adding a new contact. See CrmConsent for fields.

RETURNS

Returns an array of CrmConsent to be used when adding and updating a contact

gethttps://customcrmapi.example.com/consents
RESPONSE JSON
[
{
"consentid": "1",
"name": "Terms And Conditions",
"description": "I agree to the terms and conditions",
"value": true
},
{
"consentid": "2",
"name": "Marketing Consent",
"description": "I consent to marketing being sent to me",
"value": true
}
]
HTTP Status Code Summary
200Returns an array of CrmConsent to be used when adding and updating a contact
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
500Internal Server Error.

Objects

crmconsent
object

PROPERTIES
consentid
string

ID of the consent.

name
string

Name displayed for the consent.

description
string

Description of the consent.

value
boolean

Boolean value indicating if the default value when adding a new contact should be to accept the consent or not.