API Reference

Get a consent

get
https://{project_url}/webservice/rest-api/{api_interface}/{version}/agreements/

Get the details of a specific consent type, including its name and associated communication channels. Consent type IDs are used when reading or updating consent records on a customer. See Consent impact on segmentation and communication for details.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique ID of a consent in CareCloud.

Headers
string
Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Updated 12 days ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 days ago