Skip to main content
POST
/
marketing_subscription
Create Marketing Subscription
curl --request POST \
  --url https://integration.getmateo.com/api/v1/marketing_subscription \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "marketing_channel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "now()",
  "updated_at": "now()",
  "key": "<string>",
  "status": "requested",
  "channel_type": "email"
}
'
{
  "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "marketing_channel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "now()",
  "updated_at": "now()",
  "key": "<string>",
  "status": "requested",
  "channel_type": "email"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
select
string

Filtering Columns

Body

application/json

marketing_subscription

​
contact_id
string<uuid>

Contact ID

​
marketing_channel_id
string<uuid>

Marketing channel ID

​
organisation_id
string<uuid>

Organisation ID

​
created_at
string<timestamp with time zone>
default:now()

Marketing subscription creation date

​
updated_at
string<timestamp with time zone>
default:now()

Latest update

​
key
string<text>

Marketing subscription key

​
status
enum<string>

Status of Marketing subscription

Available options:
requested,
accepted,
declined
​
channel_type
enum<string>

Channel Type of Conversation

Available options:
email,
sms,
whatsapp,
instagram,
facebook,
google_business_messaging,
postal

Response

The updated Marketing Subscription object

​
contact_id
string<uuid>

Contact ID

​
marketing_channel_id
string<uuid>

Marketing channel ID

​
organisation_id
string<uuid>

Organisation ID

​
created_at
string<timestamp with time zone>
default:now()

Marketing subscription creation date

​
updated_at
string<timestamp with time zone>
default:now()

Latest update

​
key
string<text>

Marketing subscription key

​
status
enum<string>

Status of Marketing subscription

Available options:
requested,
accepted,
declined
​
channel_type
enum<string>

Channel Type of Conversation

Available options:
email,
sms,
whatsapp,
instagram,
facebook,
google_business_messaging,
postal