Campaigns

Create a campaign draft for phones or contacts

post/api/v1/workspaces/{workspaceId}/campaigns

Request

  • Base URL: https://otprun.com
  • URL: https://otprun.com/api/v1/workspaces/{workspaceId}/campaigns
  • Auth: HTTP bearer

Path parameters

workspaceIdinteger required

Request body

all_contactsboolean
contact_idsinteger[] nullable
footerstring

Added after the text, for example how to unsubscribe

namestring required
phonesstring[] nullable
project_idinteger required
textstring required

{name} is replaced with the recipient's name from the address book

Response

Created

created_atstring date-time required
finished_atstring date-time nullable required
footerstring required
idinteger required
namestring required
project_idinteger required
public_idstring required
started_atstring date-time nullable required
status'draft' | 'running' | 'paused' | 'done' | 'canceled' required
textstring required
totalinteger required

Changes

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