Jump to

• Request
• Response
• Examples

Send a contact through a campaign flow starting at the specified entry point.

post

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

Request

Path Parameters

• id: integer
  The unique identifier of the contact.

Body ()

Root Schema : schema

Type: object

Show Source

• campaign(optional): object campaign
  The campaign to be executed.
• entryPoint(optional): string
  The entry point for the campaign flow.
• flow(optional): object flow
  The flow to be executed.

{
    "type":"object",
    "properties":{
        "entryPoint":{
            "type":"string",
            "description":"The entry point for the campaign flow."
        },
        "flow":{
            "type":"object",
            "description":"The flow to be executed.",
            "properties":{
                "id":{
                    "type":"integer"
                },
                "lookupName":{
                    "type":"string"
                }
            }
        },
        "campaign":{
            "type":"object",
            "description":"The campaign to be executed.",
            "properties":{
                "id":{
                    "type":"integer"
                },
                "lookupName":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : campaign

Type: object

The campaign to be executed.

Show Source

• id(optional): integer
• lookupName(optional): string

{
    "type":"object",
    "description":"The campaign to be executed.",
    "properties":{
        "id":{
            "type":"integer"
        },
        "lookupName":{
            "type":"string"
        }
    }
}

Nested Schema : flow

Type: object

The flow to be executed.

Show Source

• id(optional): integer
• lookupName(optional): string

{
    "type":"object",
    "description":"The flow to be executed.",
    "properties":{
        "id":{
            "type":"integer"
        },
        "lookupName":{
            "type":"string"
        }
    }
}

Back to Top

Response

Default Response

Back to Top

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.

Back to Top