Skip to content
Kalipto Devs Platform — API Docs

Create

POST
/platform/v1/broadcasts
 
curl --request POST \
  --url https://example.com/platform/v1/broadcasts \
  --header 'Content-Type: application/json' \
  --data '{ "channel_id": 1, "language_code": "es", "name": "example", "template_name": "example" }'

Create a draft broadcast.

Errors: * 403 broadcasts_not_in_plan — free tier (broadcast_recipients_limit == 0). * 429 broadcasts_per_month_quota — over the per-month cap. * 422 channel_not_found / channel_not_active / channel_not_whatsapp.

Request Body required

Section titled “Request Body required ”
Media type application/json
PlatformBroadcastCreate
object
channel_id
required
Channel Id
integer
language_code
Language Code
string
default: es
name
required
Name
string
>= 1 characters <= 200 characters
template_name
required
Template Name
string
>= 1 characters <= 512 characters

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful Response

Media type application/json
PlatformBroadcastResponse

Full broadcast row — the wire-key for the channel is platform_channel_id (FastAPI serializes Pydantic v2 aliases as JSON keys by default — mirror platform_data_plane.PlatformMessageResponse).

object
completed_at
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
id
required
Id
integer
language_code
required
Language Code
string
name
required
Name
string
platform_channel_id
required
Platform Channel Id
integer
recipient_count
required
Recipient Count
integer
scheduled_at
Any of:
string format: date-time
started_at
Any of:
string format: date-time
status
required
Status
string
template_name
required
Template Name
string
updated_at
required
Updated At
string format: date-time
Example generated
{
  "completed_at": "2026-04-15T12:00:00Z",
  "created_at": "2026-04-15T12:00:00Z",
  "id": 1,
  "language_code": "example",
  "name": "example",
  "platform_channel_id": 1,
  "recipient_count": 1,
  "scheduled_at": "2026-04-15T12:00:00Z",
  "started_at": "2026-04-15T12:00:00Z",
  "status": "example",
  "template_name": "example",
  "updated_at": "2026-04-15T12:00:00Z"
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}