Broadcasts

Send broadcast test

Send a broadcast test. Can only send tests for broadcasts in DRAFT, CANCELLED or FAILED status.

post/orgs/broadcasts/{broadcast_id}/send/test

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/orgs/broadcasts/{broadcast_id}/send/test
  • Auth: HTTP bearer

Path parameters

broadcast_idstring required

Broadcast ID

Request body

user_idstring

The user ID of the contact channel

namestring nullable

The name for the contact channel (e.g. John Doe)

emailstring

The email for the contact channel (e.g. user@example.com)

phonestring

The phone number for the contact channel (e.g. +1234567890)

propertiesBroadcastFieldValuesSchema

A record of field keys and values per broadcast contact

template_idsstring[]

Optional list of template IDs to test. If omitted, all templates are tested.

Response

user_idstring

The user ID of the contact channel

namestring nullable

The name for the contact channel (e.g. John Doe)

emailstring

The email for the contact channel (e.g. user@example.com)

phonestring

The phone number for the contact channel (e.g. +1234567890)

propertiesBroadcastFieldValuesSchema

A record of field keys and values per broadcast contact

template_idsstring[]

Optional list of template IDs to test. If omitted, all templates are tested.

Changes

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