Retrieve people’s subscription statuses (subscriptions)
The subscriptions Ortto endpoint of the person entity is used to retrieve subscription statuses from one or more person records in Ortto’s customer data platform (CDP).
This page provides descriptions of this endpoint’s:
-
valid parameters, headers, and request body values, as well as
-
the response payload.
Headers
This endpoint requires a custom API key and content type (application/json for the request body) in the header of the request:
-
X-Api-Key: CUSTOM-PRIVATE-API-KEY -
Content-Type: application/json
Request body
The request body consists of a JSON object whose valid elements are listed in the table below.
The following JSON object is an example of field and object data that Ortto can recognize to get data from one or more person records in your Ortto account’s CDP.
{
"audience_id": "625f7213a914327aa1999b43",
"people": [
{
"email": "chris@example.com"
}
]
}Response payload
The response payload consists of a JSON object whose elements are listed in the table below.
The following JSON object is an example of people’s data that Ortto retrieves from your Ortto account’s CDP after a request to this endpoint.
{
"people": [
{
"person_status": "merged",
"person_id": "00624536230993474f078a00",
"subscriptions": [
{
"audience_id": "625f7213a914327aa1999b43",
"audience_name": "Weekly updates",
"member_from": "2022-04-20T02:38:11Z",
"subscribed": true,
"subscribed_from": "2022-04-20T02:38:11Z",
"sms_opted_in": false
},
{
"audience_id": "6241681069639ee210f8a298",
"audience_name": "Subscribers",
"member_from": "2022-03-31T05:03:31Z",
"subscribed": true,
"subscribed_from": "2022-03-31T05:03:31Z",
"sms_opted_in": false
},
{
"audience_id": "6241681069639ee210f8a29a",
"audience_name": "Engaged subscribers",
"member_from": "2022-03-31T12:56:14Z",
"subscribed": true,
"subscribed_from": "2022-03-31T12:56:15Z",
"sms_opted_in": false
}
],
"email_permissions": true,
"sms_permissions": false
}
]
}