Skip to content
Kalipto Devs Platform — API Docs

Update

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

DP-2: edit a draft broadcast (partial update).

Errors: * 404 not_found — not found / not owned. * 409 status_locked — not in draft. * 422 template_not_approved — new template_name is not approved-marketing.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
broadcast_id
required
Broadcast Id
integer

Request Body required

Section titled “Request Body required ”
Media type application/json
PlatformBroadcastUpdate

DP-2 partial edit for a draft broadcast — all fields optional.

The handler applies model_dump(exclude_none=True) so an absent field is a no-op (never an explicit null write).

object
language_code
Any of:
string
name
Any of:
string
>= 1 characters <= 200 characters
template_name
Any of:
string
>= 1 characters <= 512 characters
Example generated
{
  "language_code": "example",
  "name": "example",
  "template_name": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

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"
    }
  ]
}