Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Use an API key from https://nuntly.com/api-keys. Required on every endpoint.

Path Parameters

broadcastId
string
required

Body

application/json
templateId
string | null

Set to null to detach the template.

Example:

"tpl_01kabn43yqyxn2bx4ve84mczd3"

from
string

The sender address, on a verified domain.

Example:

"Tomlinson AI <ray@info.tomlinson.ai>"

name
string | null

Set to null to remove the name.

subject
string | null

Set to null to fall back to the template version’s subject.

Example:

"Verify your email address"

replyTo

The email address where replies should be sent. If a recipient replies, the response will go to this address instead of the sender's email address

Example:

"support@company.com"

topicId
string | null

Set to null to remove the topic.

Example:

"tpc_01kabn43yqyxn2bx4ve84mczd3"

segmentId
string | null

Set to null to remove the segment.

Example:

"seg_01kabn43yqyxn2bx4ve84mczd3"

variables
object

Replaces the stored values. Send {} to clear them.

status
enum<string>

Only draft is accepted.

Available options:
draft,
scheduled,
queued,
sending,
sent,
paused,
failed

Response

Successful response.

data
object
required