Create An Outreach Workflow Stage

curl --request POST \
  --url http://api.stuut.ai/v1/outreach-workflows/{outreach_workflow_id}/stages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "auto_send": true,
  "cc": [
    "jsmith@example.com"
  ],
  "cc_secondary_contacts": false,
  "email_template": "<string>",
  "external_roles_to_cc": [],
  "internal_roles_to_cc": [],
  "is_always_run_enabled": true,
  "num_days": 123,
  "outreach_window_start": "<string>",
  "outreach_window_end": "<string>",
  "recurrence_interval_days": 123,
  "recurrence_end_offset_days": 123
}
'

import requests

url = "http://api.stuut.ai/v1/outreach-workflows/{outreach_workflow_id}/stages"

payload = {
    "name": "<string>",
    "auto_send": True,
    "cc": ["jsmith@example.com"],
    "cc_secondary_contacts": False,
    "email_template": "<string>",
    "external_roles_to_cc": [],
    "internal_roles_to_cc": [],
    "is_always_run_enabled": True,
    "num_days": 123,
    "outreach_window_start": "<string>",
    "outreach_window_end": "<string>",
    "recurrence_interval_days": 123,
    "recurrence_end_offset_days": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    auto_send: true,
    cc: ['jsmith@example.com'],
    cc_secondary_contacts: false,
    email_template: '<string>',
    external_roles_to_cc: [],
    internal_roles_to_cc: [],
    is_always_run_enabled: true,
    num_days: 123,
    outreach_window_start: '<string>',
    outreach_window_end: '<string>',
    recurrence_interval_days: 123,
    recurrence_end_offset_days: 123
  })
};

fetch('http://api.stuut.ai/v1/outreach-workflows/{outreach_workflow_id}/stages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://api.stuut.ai/v1/outreach-workflows/{outreach_workflow_id}/stages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'auto_send' => true,
    'cc' => [
        'jsmith@example.com'
    ],
    'cc_secondary_contacts' => false,
    'email_template' => '<string>',
    'external_roles_to_cc' => [
        
    ],
    'internal_roles_to_cc' => [
        
    ],
    'is_always_run_enabled' => true,
    'num_days' => 123,
    'outreach_window_start' => '<string>',
    'outreach_window_end' => '<string>',
    'recurrence_interval_days' => 123,
    'recurrence_end_offset_days' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://api.stuut.ai/v1/outreach-workflows/{outreach_workflow_id}/stages"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"auto_send\": true,\n  \"cc\": [\n    \"jsmith@example.com\"\n  ],\n  \"cc_secondary_contacts\": false,\n  \"email_template\": \"<string>\",\n  \"external_roles_to_cc\": [],\n  \"internal_roles_to_cc\": [],\n  \"is_always_run_enabled\": true,\n  \"num_days\": 123,\n  \"outreach_window_start\": \"<string>\",\n  \"outreach_window_end\": \"<string>\",\n  \"recurrence_interval_days\": 123,\n  \"recurrence_end_offset_days\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://api.stuut.ai/v1/outreach-workflows/{outreach_workflow_id}/stages")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"auto_send\": true,\n  \"cc\": [\n    \"jsmith@example.com\"\n  ],\n  \"cc_secondary_contacts\": false,\n  \"email_template\": \"<string>\",\n  \"external_roles_to_cc\": [],\n  \"internal_roles_to_cc\": [],\n  \"is_always_run_enabled\": true,\n  \"num_days\": 123,\n  \"outreach_window_start\": \"<string>\",\n  \"outreach_window_end\": \"<string>\",\n  \"recurrence_interval_days\": 123,\n  \"recurrence_end_offset_days\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://api.stuut.ai/v1/outreach-workflows/{outreach_workflow_id}/stages")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"auto_send\": true,\n  \"cc\": [\n    \"jsmith@example.com\"\n  ],\n  \"cc_secondary_contacts\": false,\n  \"email_template\": \"<string>\",\n  \"external_roles_to_cc\": [],\n  \"internal_roles_to_cc\": [],\n  \"is_always_run_enabled\": true,\n  \"num_days\": 123,\n  \"outreach_window_start\": \"<string>\",\n  \"outreach_window_end\": \"<string>\",\n  \"recurrence_interval_days\": 123,\n  \"recurrence_end_offset_days\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "event": "<string>",
  "name": "<string>",
  "object": "<string>",
  "time_trigger": "<string>",
  "workflow_id": "<string>",
  "id": "<string>",
  "auto_send": true,
  "cc": [
    "<string>"
  ],
  "cc_secondary_contacts": true,
  "created_at": "2023-11-07T05:31:56Z",
  "email_template": {
    "object": "<string>",
    "id": "<string>",
    "auto_correct": true,
    "body": "<string>",
    "cc": [
      "<string>"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "folder_id": "<string>",
    "is_default": true,
    "modified_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "subject": "<string>"
  },
  "external_roles_to_cc": [
    "<string>"
  ],
  "fallback_email_template": {
    "object": "<string>",
    "id": "<string>",
    "auto_correct": true,
    "body": "<string>",
    "cc": [
      "<string>"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "folder_id": "<string>",
    "is_default": true,
    "modified_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "subject": "<string>"
  },
  "internal_roles_to_cc": [
    "<string>"
  ],
  "is_always_run_enabled": true,
  "modified_at": "2023-11-07T05:31:56Z",
  "num_days": 123,
  "outreach_window_end": "<string>",
  "outreach_window_start": "<string>",
  "recurrence_end_offset_days": 123,
  "recurrence_interval_days": 123
}

{
  "data": {},
  "error": "<string>",
  "message": "<string>"
}

{
  "data": {},
  "error": "<string>",
  "message": "<string>"
}

{
  "detail": {
    "<location>": {
      "<field_name>": [
        "<string>"
      ]
    }
  },
  "message": "<string>"
}

POST

outreach-workflows

{outreach_workflow_id}

stages

Create An Outreach Workflow Stage

curl --request POST \
  --url http://api.stuut.ai/v1/outreach-workflows/{outreach_workflow_id}/stages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "auto_send": true,
  "cc": [
    "jsmith@example.com"
  ],
  "cc_secondary_contacts": false,
  "email_template": "<string>",
  "external_roles_to_cc": [],
  "internal_roles_to_cc": [],
  "is_always_run_enabled": true,
  "num_days": 123,
  "outreach_window_start": "<string>",
  "outreach_window_end": "<string>",
  "recurrence_interval_days": 123,
  "recurrence_end_offset_days": 123
}
'

import requests

url = "http://api.stuut.ai/v1/outreach-workflows/{outreach_workflow_id}/stages"

payload = {
    "name": "<string>",
    "auto_send": True,
    "cc": ["jsmith@example.com"],
    "cc_secondary_contacts": False,
    "email_template": "<string>",
    "external_roles_to_cc": [],
    "internal_roles_to_cc": [],
    "is_always_run_enabled": True,
    "num_days": 123,
    "outreach_window_start": "<string>",
    "outreach_window_end": "<string>",
    "recurrence_interval_days": 123,
    "recurrence_end_offset_days": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    auto_send: true,
    cc: ['jsmith@example.com'],
    cc_secondary_contacts: false,
    email_template: '<string>',
    external_roles_to_cc: [],
    internal_roles_to_cc: [],
    is_always_run_enabled: true,
    num_days: 123,
    outreach_window_start: '<string>',
    outreach_window_end: '<string>',
    recurrence_interval_days: 123,
    recurrence_end_offset_days: 123
  })
};

fetch('http://api.stuut.ai/v1/outreach-workflows/{outreach_workflow_id}/stages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://api.stuut.ai/v1/outreach-workflows/{outreach_workflow_id}/stages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'auto_send' => true,
    'cc' => [
        'jsmith@example.com'
    ],
    'cc_secondary_contacts' => false,
    'email_template' => '<string>',
    'external_roles_to_cc' => [
        
    ],
    'internal_roles_to_cc' => [
        
    ],
    'is_always_run_enabled' => true,
    'num_days' => 123,
    'outreach_window_start' => '<string>',
    'outreach_window_end' => '<string>',
    'recurrence_interval_days' => 123,
    'recurrence_end_offset_days' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://api.stuut.ai/v1/outreach-workflows/{outreach_workflow_id}/stages"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"auto_send\": true,\n  \"cc\": [\n    \"jsmith@example.com\"\n  ],\n  \"cc_secondary_contacts\": false,\n  \"email_template\": \"<string>\",\n  \"external_roles_to_cc\": [],\n  \"internal_roles_to_cc\": [],\n  \"is_always_run_enabled\": true,\n  \"num_days\": 123,\n  \"outreach_window_start\": \"<string>\",\n  \"outreach_window_end\": \"<string>\",\n  \"recurrence_interval_days\": 123,\n  \"recurrence_end_offset_days\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://api.stuut.ai/v1/outreach-workflows/{outreach_workflow_id}/stages")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"auto_send\": true,\n  \"cc\": [\n    \"jsmith@example.com\"\n  ],\n  \"cc_secondary_contacts\": false,\n  \"email_template\": \"<string>\",\n  \"external_roles_to_cc\": [],\n  \"internal_roles_to_cc\": [],\n  \"is_always_run_enabled\": true,\n  \"num_days\": 123,\n  \"outreach_window_start\": \"<string>\",\n  \"outreach_window_end\": \"<string>\",\n  \"recurrence_interval_days\": 123,\n  \"recurrence_end_offset_days\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://api.stuut.ai/v1/outreach-workflows/{outreach_workflow_id}/stages")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"auto_send\": true,\n  \"cc\": [\n    \"jsmith@example.com\"\n  ],\n  \"cc_secondary_contacts\": false,\n  \"email_template\": \"<string>\",\n  \"external_roles_to_cc\": [],\n  \"internal_roles_to_cc\": [],\n  \"is_always_run_enabled\": true,\n  \"num_days\": 123,\n  \"outreach_window_start\": \"<string>\",\n  \"outreach_window_end\": \"<string>\",\n  \"recurrence_interval_days\": 123,\n  \"recurrence_end_offset_days\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "event": "<string>",
  "name": "<string>",
  "object": "<string>",
  "time_trigger": "<string>",
  "workflow_id": "<string>",
  "id": "<string>",
  "auto_send": true,
  "cc": [
    "<string>"
  ],
  "cc_secondary_contacts": true,
  "created_at": "2023-11-07T05:31:56Z",
  "email_template": {
    "object": "<string>",
    "id": "<string>",
    "auto_correct": true,
    "body": "<string>",
    "cc": [
      "<string>"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "folder_id": "<string>",
    "is_default": true,
    "modified_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "subject": "<string>"
  },
  "external_roles_to_cc": [
    "<string>"
  ],
  "fallback_email_template": {
    "object": "<string>",
    "id": "<string>",
    "auto_correct": true,
    "body": "<string>",
    "cc": [
      "<string>"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "folder_id": "<string>",
    "is_default": true,
    "modified_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "subject": "<string>"
  },
  "internal_roles_to_cc": [
    "<string>"
  ],
  "is_always_run_enabled": true,
  "modified_at": "2023-11-07T05:31:56Z",
  "num_days": 123,
  "outreach_window_end": "<string>",
  "outreach_window_start": "<string>",
  "recurrence_end_offset_days": 123,
  "recurrence_interval_days": 123
}

{
  "data": {},
  "error": "<string>",
  "message": "<string>"
}

{
  "data": {},
  "error": "<string>",
  "message": "<string>"
}

{
  "detail": {
    "<location>": {
      "<field_name>": [
        "<string>"
      ]
    }
  },
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

outreach_workflow_id

string

required

Body

application/json

event

enum<string>

required

Available options:

invoice.due_date,

invoice.issued_at,

payment.applied

name

string

required

time_trigger

enum<string>

required

Available options:

after,

before,

on

action

enum<string>

Available options:

email,

call

auto_send

boolean

string<email>[]

cc_secondary_contacts

boolean

default:false

email_template

string | null

The EmailTemplate identifier, (e.g. eml_tmpl_abc123).

external_roles_to_cc

enum<string>[]

Available options:

billing_contact,

executive,

economic_user

internal_roles_to_cc

enum<string>[]

Available options:

account_manager,

account_executive,

csm

is_always_run_enabled

boolean

num_days

integer

outreach_window_start

string | null

outreach_window_end

string | null

recurrence_interval_days

integer | null

recurrence_end_offset_days

integer | null

Response

Successful response

action

enum<string>

required

Available options:

email,

call

Maximum string length: 5

event

string

required

name

string

required

The name of the stage.

object

string

required

time_trigger

string

required

workflow_id

string

required

Maximum string length: 32

string

Maximum string length: 32

auto_send

boolean

Whether to automatically send emails created by this stage. When false, the emails will be created and left in a draft state for you to send. Defaults to true.

string[]

List of email addresses to CC on the emails created by this stage.

cc_secondary_contacts

boolean

Whether to CC all external contacts on the emails created by this stage.

created_at

string<date-time>

email_template

object

Show child attributes

external_roles_to_cc

string[]

List of external roles to CC on the emails created by this stage.

fallback_email_template

object

Show child attributes

internal_roles_to_cc

string[]

List of internal roles to CC on the emails created by this stage.

is_always_run_enabled

boolean

Whether to ignore the workflow's active days.

modified_at

string<date-time> | null

num_days

integer | null

outreach_window_end

string | null

Override end time for outreach window (optional stage-level override)

outreach_window_start

string | null

Override start time for outreach window (optional stage-level override)

recurrence_end_offset_days

integer | null

If set, stops recurring after N days past the event date; null where time_trigger = 'before' = until event date, null where time_trigger = 'after' = forever.

recurrence_interval_days

integer | null

If set (>0), after the initial trigger this stage will re-fire every X days. Null = no recurrence.

List Outreach Workflow Stages Retrieve An Outreach Workflow Stage

⌘I