Sign in

v1

latestOpenAPI 3.1.02026-08-0612447737.4 KB
Marketing Subscription

List Marketing Subscriptions

Retrieve a list of marketing subscriptions

get/marketing_subscription

Query parameters

contact_idstring

Contact ID

marketing_channel_idstring

Marketing channel ID

organisation_idstring

Organisation ID

created_atstring

Marketing subscription creation date

updated_atstring

Latest update

keystring

Marketing subscription key

statusstring

Status of Marketing subscription

channel_typestring

Channel Type of Conversation

selectstring

Filtering Columns

offsetstring

Limiting and Pagination

limitstring

Limiting and Pagination

Headers

Rangestring

Limiting and Pagination

Range-Unitstring

Limiting and Pagination

Response

OK

contact_idstring uuid

Contact ID

marketing_channel_idstring uuid

Marketing channel ID

organisation_idstring uuid

Organisation ID

created_atstring timestamp with time zone

Marketing subscription creation date

updated_atstring timestamp with time zone

Latest update

keystring text

Marketing subscription key

status'requested' | 'accepted' | 'declined' public.marketing_subscription_status

Status of Marketing subscription

channel_type'email' | 'sms' | 'whatsapp' | 'instagram' | 'facebook' | 'google_business_messaging' | 'postal' public.channel_type

Channel Type of Conversation