Create

POST

/api/v1/newsletter/create

Creates a new WhatsApp newsletter channel.

⚠️ Newsletter functionality is in BETA testing. Features and implementation may change.

Request

Header Params

Body Params application/json

Example

{
    "name": "Newsletter",
    "description": "Newsletter Top"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://nexus.sourei.com.br/api/v1/newsletter/create' \
--header 'Authorization: Bearer {{token}}' \
--header 'x-session-id: {{session_id}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Newsletter",
    "description": "Newsletter Top"
}'

Responses

🟢200Success

application/json

Body

Example

{
    "id": "string",
    "state": "string",
    "creation_time": 0,
    "name": "string",
    "nameTime": 0,
    "description": "string",
    "descriptionTime": 0,
    "invite": "string",
    "handle": null,
    "picture": null,
    "preview": null,
    "subscribers": 0,
    "verification": "string",
    "viewer_metadata": {
        "mute": "string",
        "role": "string"
    }
}

Modified at 2025-01-24 18:16:32

Remove Phone From Label

Update