ACactivecampaign
Broadcasts

Update broadcast message

Updates an existing broadcast message

put/sms/broadcasts/{id}

Request

  • Base URL
    https://yourAccountName.api-us1.com/api/3
  • URL
    https://yourAccountName.api-us1.com/api/3/sms/broadcasts/{id}
  • Auth
    API key in header Api-Token

Path parameters

idinteger required

Broadcast ID

Request body

namestring
address_idinteger nullable
bodystring
media_urlsstring[]
preview_urlstring uri
shorten_track_links_enabledboolean
status'draft' | 'pending_review'

Status of the broadcast. pending_review starts kicks off the broadcast to be sent

scheduled_datestring date-time
sent_to_countinteger
list_idsinteger[]
segment_idstring
custom_run_idstring uuid nullable

custom run id generated from segmentMatchSome endpoint and passing a valid segment id

custom_segment_idstring uuid nullable

custom segment id generated from segmentsV2 endpoint and passing in a valid audience

label_idsinteger[]

Response

Broadcast updated successfully

idinteger

Unique identifier for the broadcast

namestring

Name of the broadcast

address_idinteger nullable

ID used to get sender name

bodystring

SMS message content

media_urlsstring[]

Media URLs for MMS messages

preview_urlstring uri

URL for message preview

shorten_track_links_enabledboolean

Whether link shortening is enabled

status'draft' | 'scheduled' | 'sent' | 'pending_review' | 'sending'

Current status of the broadcast

sent_datestring date-time nullable

Date when broadcast was sent

scheduled_datestring date-time nullable

Scheduled send date (UTC)

custom_run_idstring uuid nullable

custom run id generated from segmentMatchSome endpoint

custom_segment_idstring uuid nullable

custom segment id generated from segmentsV2 endpoint and passing in a valid audience

scheduled_byinteger nullable

User ID who scheduled the broadcast

sent_to_countinteger nullable

Number of recipients

created_atstring date-time

Creation timestamp

created_byinteger

User ID who created the broadcast

updated_atstring date-time

Last update timestamp

updated_byinteger

User ID who last updated

deleted_atstring date-time nullable

Deletion timestamp (for soft deletes)

sift_approvedinteger

Sift approval status

arc_approvedinteger

ARC approval status

quiet_hours_enabledinteger nullable

Whether quiet hours are enabled

list_idsinteger[]

Associated list IDs

segment_idstring nullable

Segment ID (can be UUID or integer string)

label_idsinteger[] nullable

Associated label IDs

Changes

No recorded changes to this operation across all 1 revision of this API.