Broadcasts
Update broadcast fields (partial)
Field-level patch. A prompt_template change re-derives
required_variables. Completed broadcasts are immutable
(409 broadcasts.completed).
Authorization
bearerAuth AuthorizationBearer <token>
Long-lived ES256 JWT minted from the dashboard (https://app.sautikit.com/developers/api-keys). Signed by the
platform keyring. Carries workspace_id and scopes claims;
revoked via the platform deny-list.
In: header
Path Parameters
id*string
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/v1/broadcasts/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "daily_end_minute": 1080, "max_attempts": 4, "retry_on": [ "no_answer", "busy", "voicemail" ] }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978", "caller_number_id": "6724ddc7-3cb4-46c7-90e2-4e18c26317c6", "name": "string", "prompt_template": "string", "start_phrase": "string", "required_variables": [ "string" ], "schedule_days": [ 0 ], "daily_start_minute": 0, "daily_end_minute": 0, "timezone": "string", "max_attempts": 0, "backoff_minutes": 0, "retry_on": [ "no_answer" ], "state": "draft", "reason": "string", "completed_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}{ "error": { "code": "validation.bad_request", "message": "string", "request_id": "string" }}{ "error": { "code": "validation.bad_request", "message": "string", "request_id": "string" }}{ "error": { "code": "validation.bad_request", "message": "string", "request_id": "string" }}{ "error": { "code": "validation.bad_request", "message": "string", "request_id": "string" }}