Skip to main content
POST
/
newsletters
Create a newsletter
curl --request POST \
  --url https://api.wsapi.chat/newsletters \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>' \
  --data '
{
  "name": "My Newsletter",
  "description": "Updates about cool stuff"
}
'
{
  "id": "01234567890123456"
}

Authorizations

​
X-Api-Key
string
header
required

Instance or customer-level API key. Either the instance's own API key or the customer's API key is accepted. Must be paired with the X-Instance-Id header to identify the target instance.

Headers

​
X-Instance-Id
string
default:{{instanceId}}
required

The ID of the WhatsApp instance to use

Body

application/json
​
name
string
required

Newsletter name

​
description
string

Newsletter description

​
picture
string

Base64-encoded profile picture for the newsletter

Response

Resource created

​
id
string

ID of the created resource