Sends a contact through a campaign flow starting at the specified entry point

post

/services/rest/connect/v1.4/contacts/{id}/executeMarketingFlow

Request

Path Parameters
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : campaign
Type: object
Campaign that will be executed
Show Source
Nested Schema : flow
Type: object
Flow that will be executed
Show Source

Response

Default Response

Examples

You can initiate a marketing campaign or flow by providing an entry point and relevant details using the REST API. Use POST with the following syntax to execute a marketing campaign or flow:

https://your_site_interface/services/rest/connect/version/contacts/contact_id/executeMarketingFlow

The request has the parameters shown in the following table.

Parameter Description
campaign or flow Campaign or flow ID. You cannot use both.
entryPoint Entry point to the flow

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/contacts/1/executeMarketingFlow

Request body example

{
"campaign": {"id": 123},
"entryPoint": "entry0"
}

Response example

The status 200 OK is returned, indicating that the marketing campaign has been executed.