Sign in

v1

latestOpenAPI 3.0.02026-07-267581167.5 KB
Subscription API

Get subscription status for list by external_person_id

get/companies/{company_key}/mobiledb/persons/external/{external_person_id}/subscriptions/{subscription_list_id}

Path parameters

company_keystring required
external_person_idstring required
subscription_list_idstring required

Headers

X-API-Versionstring

Response

Successful response

opt_in_datestring

Date string indicating when the subscription was entered in ISO-8601 format.

opt_out_datestring

Date string indicating when the subscription was ended, if relevant, in ISO-8601 format.

opt_out_reason'user_opt_out' | 'disconnect' | 'list_archived' | 'bulk_opt_out' | 'failed_at_carrier' | 'obsolete_carrier' | 'platform_opt_out' | 'keyword_opt_out' | 'api_opt_out' | 'button_opt_out'

The reason why the person was opted-out, if relevant.

urlstring

A reference URL to the existing object, as a relative URL to the existing domain.