Skip to main content
POST
Create campaign message

Authorizations

X-Api-Key
string
header
required

Your secret ReachBoost API key.

Path Parameters

workspace_uuid
string<uuid>
required

Your unique workspace identifier.

Example:

"YOUR_WORKSPACE_UUID"

campaign_uuid
string<uuid>
required

The unique identifier for the campaign.

Example:

"YOUR_CAMPAIGN_UUID"

Body

application/json
message_type
enum<string>
required
Available options:
connection_request,
follow_up
wait
integer

Wait in days before sending the message. Defaults to 1.

Required range: 0 <= x <= 30
message_content
string | null

Message body. Required for follow_up. Optional for connection_request (empty requests are supported).

Response

Campaign message created

campaign_uuid
string<uuid>
campaign_name
string
campaign_status
enum<string>
Available options:
draft,
active,
inactive,
finished
campaign_type
enum<string>
Available options:
new_connections,
existing_connections
campaign_messages
object[]