Drip Campaigns

Drip Campaign Controls

Drip Campaign Messages

Create Drip Campaign

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestringRequired
endDatestringOptional
Responses
chevron-right
200

Success

application/json
post
/drip-campaigns

Get Drip Campaign

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
dripCampaignIdstringRequired
Responses
chevron-right
200

Success

application/json
get
/drip-campaigns/{dripCampaignId}

Update Drip Campaign

patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
dripCampaignIdstringRequired
Body
namestringOptional
endDatestringOptional
Responses
chevron-right
200

Success

application/json
patch
/drip-campaigns/{dripCampaignId}

Delete Drip Campaign

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
dripCampaignIdstringRequired
Responses
delete
/drip-campaigns/{dripCampaignId}

No content

List Drip Campaigns

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
Responses
chevron-right
200

Success

application/json
get
/drip-campaigns

Start Drip Campaign

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
dripCampaignIdstringRequired
Body
groupIdnumberRequired
Responses
chevron-right
200

Success

application/json
post
/drip-campaigns/{dripCampaignId}/start

Stop Drip Campaign

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
dripCampaignIdstringRequired
Body
groupIdnumberRequired
Responses
chevron-right
200

Success

application/json
post
/drip-campaigns/{dripCampaignId}/stop

Clone Drip Campaign

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
dripCampaignIdstringRequired
Responses
chevron-right
200

Success

application/json
post
/drip-campaigns/{dripCampaignId}/clone

List Drip Campaign Numbers

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
dripCampaignIdstringRequired
sequenceIdstringRequired
Responses
chevron-right
200

Success

application/json
get
/drip-campaigns/{dripCampaignId}/numbers/{sequenceId}

Create Drip Campaign Message

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
dripCampaignIdstringRequired
Body
titlestring | nullableOptional
contentstring | nullableOptional
attachmentstring | nullableOptional
delaynumberOptional
timeOfDaystringOptional
isMmsnumberOptional
previousIdnumberOptional
templateIdnumberOptional
Responses
chevron-right
200

Success

application/json
post
/drip-campaigns/{dripCampaignId}/messages

Update Drip Campaign Message

patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
dripCampaignIdstringRequired
messageIdstringRequired
Body
titlestring | nullableOptional
contentstring | nullableOptional
attachmentstring | nullableOptional
delaynumberOptional
timeOfDaystringOptional
isMmsnumberOptional
previousIdnumberOptional
templateIdnumberOptional
Responses
chevron-right
200

Success

application/json
patch
/drip-campaigns/{dripCampaignId}/messages/{messageId}

Delete Drip Campaign Message

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
dripCampaignIdstringRequired
messageIdstringRequired
Responses
chevron-right
200

Success

application/json
delete
/drip-campaigns/{dripCampaignId}/messages/{messageId}

Last updated

Was this helpful?