ORorsay
Campaigns

Create Campaign

Broadcast a personalised message to the selected leads.

post/v1/campaigns/

Request

  • Base URL
    https://client.api.prod.orsay.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://client.api.prod.orsay.ai/v1/campaigns/
  • Auth
    HTTP bearer

Request body

namestring nullable
messagestring nullable
channelsstring[] required
classificationsstring[] required
included_lead_idsstring[] nullable
excluded_lead_idsstring[] nullable
whatsapp_template_idstring nullable
whatsapp_profile_idstring nullable
instagram_user_idstring nullable
csv_phone_numbersstring[] nullable
csv_leadsobject[] nullable
override_csv_namesboolean
scheduled_atstring nullable
spread_over_daysboolean
batch_sizeinteger
batch_interval_minutesinteger
audio_urlstring nullable
agent_idstring nullable

Response

Successful Response

campaign_idstring required
total_leadsinteger required
skipped_leadsinteger
days_neededinteger
unmatched_phone_numbersstring[]
messagestring required

Changes

No recorded changes to this operation across all 12 revisions of this API.