Start workflow

Adds the specified email and begins workflow.

Endpoint

HTTP method: POST

https://api.sender.net/v2/workflows/{id}/start

---

Parameters

Parameter	Type	Description
id	string required	Workflow ID
email	string required	The email address that will be added to the workflow.

---

Request Examples

JavaScript

const url = new URL("https://api.sender.net/v2/workflows/{id}/start");

let headers = {
    "Authorization": "Bearer [your-token]",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let bodyContent = {
  "email": "[email protected]"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(bodyContent)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

PHP

$client = new \GuzzleHttp\Client();

$json = [
  "email" => "[email protected]"
];

$response = $client->post(
    'https://api.sender.net/v2/workflows/{id}/start',
    [
        'headers' => [
            'Authorization' => 'Bearer [your-token]',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => $json
    ]
);

$body = $response->getBody()->getContents();
$data = json_decode($body, true);
print_r($data);

Python

import requests
import json

url = "https://api.sender.net/v2/workflows/{id}/start"

headers = {
    "Authorization": "Bearer [your-token]",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

payload = {
  "email": "[email protected]"
}

response = requests.request('POST', url, headers=headers, json=payload)

print(response.json())

Bash

curl -X POST \
"https://api.sender.net/v2/workflows/{id}/start" \
-H "Authorization: Bearer [your-token]" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"email":"[email protected]"}'

---

Response

Example Response

{
  "success": true,
  "message": "[email protected] added to workflow."
}