broadcasts

Archive — reversible, any time, sent or draft.

post/broadcasts/{id}/archive

Request

  • Base URL: https://api.agentisend.com
  • URL: https://api.agentisend.com/broadcasts/{id}/archive
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Headers

Idempotency-Keystring

Makes this call safe to retry. Send the same key with the same body and the original response is replayed instead of the work happening twice. Keys are 1-256 characters and are remembered for 7 days. While the first attempt is still running, a second call with that key returns 409 idempotency_in_flight (Resend calls this concurrent_idempotent_requests); the same key with a different body returns 409 idempotency_payload_mismatch (Resend: invalid_idempotent_request). Resend-Idempotency-Key is accepted as the same header.

Resend-Idempotency-Keystring

Alias of Idempotency-Key. Idempotency-Key wins if both are sent.

Response

Success

object'broadcast' required
idstring uuid required
namestring required
statusstring required
from_addressstring nullable required
fromstring nullable required

Same as from_address, under the name Resend uses.

template_idstring uuid nullable required
segment_idstring uuid nullable required
audience_idstring uuid nullable required

Deprecated: the name Resend gave segment_id before segments. Same value.

subjectstring nullable required
contentobject nullable required
htmlstring nullable required

The HTML body as written, placeholders unfilled. null for a broadcast that takes its body from a template.

textstring nullable required

The plain-text body as written. null: none written, so the send derives one. An empty string: opted out of a plain-text part.

reply_tostring[] nullable required

Reply-To on every message the broadcast sends.

preview_textstring nullable required

The line an inbox shows after the subject.

topic_idstring uuid nullable required

The topic whose opt-outs the send honours. A contact who unsubscribed from it is skipped.

scheduled_atstring date-time nullable required
sent_atstring date-time nullable required
sent_countinteger required
archived_atstring date-time nullable required
created_atstring date-time required
updated_atstring date-time required

Changes

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