batch

Create batch send

Creates a new batch send job and queues it for processing

post/v1/batch/

Request

  • Base URL: https://api.wraps.dev
  • URL: https://api.wraps.dev/v1/batch/
  • Auth: HTTP bearer

Request body

namestring

Name for the batch send

topicIdstring

Topic ID to target

segmentIdstring

Segment ID to target

subjectstring

Email subject line

previewTextstring

Email preview text

fromstring

From email address

fromNamestring

From display name

replyTostring

Reply-to email address

templateIdstring

Email template ID

htmlContentstring

Raw HTML content (if not using template)

bodystring

SMS body text

senderIdstring

SMS sender ID

scheduledForstring date-time

ISO 8601 datetime for scheduled send

awsAccountIdstring required

AWS account ID to use for sending

totalRecipientsnumber

Pre-counted recipient count

Response

idstring required

Batch ID

statusstring required

Batch status (queued, scheduled, processing, completed, failed, cancelled)

channelstring required

Channel (email or sms)

totalRecipientsnumber required

Total number of recipients

createdAtstring date-time required

Creation timestamp

warningstring

Set when the broadcast was accepted but something about it needs saying — e.g. it was marked scheduled in an environment with no scheduler configured, so it will never fire.

Changes

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