Create or Update Workflow

POST

{workspace}

workflow

{slug}

cURL

curl -X POST "https://management-api.suprsend.com/v1/{workspace}/workflow/{slug}/" \
  --header 'Authorization: ServiceToken <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Welcome Email",
    "description": "Sends welcome email to new users",
    "category": "transactional",
    "trigger_type": "api",
    "tags": ["welcome", "onboarding"],
    "tree": {
      "nodes": [
        {
          "name": "Send Email",
          "node_type": "send_email",
          "properties": {
            "template": "welcome-email-template"
          },
          "description": "Send welcome email to new users"
        }
      ]
    }
  }'

import requests

url = "https://management-api.suprsend.com/v1/{workspace}/workflow/{slug}/"

payload = {
    "name": "Welcome Email",
    "description": "Sends welcome email to new users",
    "category": "transactional",
    "trigger_type": "api",
    "tags": ["welcome", "onboarding"],
    "tree": { "nodes": [
            {
                "name": "Send Email",
                "node_type": "send_email",
                "properties": { "template": "welcome-email-template" },
                "description": "Send welcome email to new users"
            }
        ] }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Welcome Email',
    description: 'Sends welcome email to new users',
    category: 'transactional',
    trigger_type: 'api',
    tags: ['welcome', 'onboarding'],
    tree: {
      nodes: [
        {
          name: 'Send Email',
          node_type: 'send_email',
          properties: {template: 'welcome-email-template'},
          description: 'Send welcome email to new users'
        }
      ]
    }
  })
};

fetch('https://management-api.suprsend.com/v1/{workspace}/workflow/{slug}/', 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 => "https://management-api.suprsend.com/v1/{workspace}/workflow/{slug}/",
  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' => 'Welcome Email',
    'description' => 'Sends welcome email to new users',
    'category' => 'transactional',
    'trigger_type' => 'api',
    'tags' => [
        'welcome',
        'onboarding'
    ],
    'tree' => [
        'nodes' => [
                [
                                'name' => 'Send Email',
                                'node_type' => 'send_email',
                                'properties' => [
                                                                'template' => 'welcome-email-template'
                                ],
                                'description' => 'Send welcome email to new users'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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 := "https://management-api.suprsend.com/v1/{workspace}/workflow/{slug}/"

	payload := strings.NewReader("{\n  \"name\": \"Welcome Email\",\n  \"description\": \"Sends welcome email to new users\",\n  \"category\": \"transactional\",\n  \"trigger_type\": \"api\",\n  \"tags\": [\n    \"welcome\",\n    \"onboarding\"\n  ],\n  \"tree\": {\n    \"nodes\": [\n      {\n        \"name\": \"Send Email\",\n        \"node_type\": \"send_email\",\n        \"properties\": {\n          \"template\": \"welcome-email-template\"\n        },\n        \"description\": \"Send welcome email to new users\"\n      }\n    ]\n  }\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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("https://management-api.suprsend.com/v1/{workspace}/workflow/{slug}/")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Welcome Email\",\n  \"description\": \"Sends welcome email to new users\",\n  \"category\": \"transactional\",\n  \"trigger_type\": \"api\",\n  \"tags\": [\n    \"welcome\",\n    \"onboarding\"\n  ],\n  \"tree\": {\n    \"nodes\": [\n      {\n        \"name\": \"Send Email\",\n        \"node_type\": \"send_email\",\n        \"properties\": {\n          \"template\": \"welcome-email-template\"\n        },\n        \"description\": \"Send welcome email to new users\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://management-api.suprsend.com/v1/{workspace}/workflow/{slug}/")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Welcome Email\",\n  \"description\": \"Sends welcome email to new users\",\n  \"category\": \"transactional\",\n  \"trigger_type\": \"api\",\n  \"tags\": [\n    \"welcome\",\n    \"onboarding\"\n  ],\n  \"tree\": {\n    \"nodes\": [\n      {\n        \"name\": \"Send Email\",\n        \"node_type\": \"send_email\",\n        \"properties\": {\n          \"template\": \"welcome-email-template\"\n        },\n        \"description\": \"Send welcome email to new users\"\n      }\n    ]\n  }\n}"

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

{
  "name": "Welcome Email",
  "description": "Sends welcome email to new users",
  "category": "transactional",
  "trigger_type": "api",
  "tags": [
    "welcome",
    "onboarding"
  ],
  "tree": {
    "nodes": [
      {
        "name": "Send Email",
        "node_type": "send_email",
        "properties": {
          "template": "welcome-email-template"
        },
        "description": "Send welcome email to new users"
      }
    ]
  },
  "validation_result": {
    "is_valid": true,
    "errors": []
  }
}

{
  "code": 123,
  "error_code": "<string>",
  "type": "<string>",
  "message": "<string>",
  "detail": "<string>"
}

{
  "code": 401,
  "error_code": "authentication_failed",
  "type": "AuthenticationFailed",
  "message": "Invalid service token.",
  "detail": "Invalid service token."
}

{
  "code": 404,
  "error_code": "not_found",
  "type": "NotFound",
  "message": "workspace 'demo' not found",
  "detail": "workspace 'demo' not found"
}

Authorizations

Authorization

string

header

required

Pass as Authorization: ServiceToken <token>. You can get Service Token from SuprSend dashboard -> Account Settings -> Service Tokens section.

Path Parameters

workspace

string

required

Workspace where the workflow should be created (staging, production, etc.)

slug

string

required

Unique identifier of the workflow. You can get it from workflow settings for existing workflows.

Query Parameters

commit

boolean

default:false

Whether to commit the workflow immediately. Workflow will be successfully committed only if validation_result.is_valid is true.

commit_message

string

Optional commit message describing the changes. Used only when commit=true.

Body

application/json

name

string

required

Human-readable name of the workflow. The workflow slug is taken from the URL path, not generated from this name.

Maximum string length: 255

Example:

"Welcome Sequence"

Response

Workflow created. The response includes the saved workflow object along with a validation_result field that indicates whether the workflow configuration is valid. When commit=true is passed, a commit_result field is also returned.

validation_result

object

Show child attributes

commit_result

object

Present only when commit=true is passed. is_committed is false if validation failed or the commit raised an error; the upsert itself is still saved.

Show child attributes

⌘I

cURL

curl -X POST "https://management-api.suprsend.com/v1/{workspace}/workflow/{slug}/" \
  --header 'Authorization: ServiceToken <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Welcome Email",
    "description": "Sends welcome email to new users",
    "category": "transactional",
    "trigger_type": "api",
    "tags": ["welcome", "onboarding"],
    "tree": {
      "nodes": [
        {
          "name": "Send Email",
          "node_type": "send_email",
          "properties": {
            "template": "welcome-email-template"
          },
          "description": "Send welcome email to new users"
        }
      ]
    }
  }'

import requests

url = "https://management-api.suprsend.com/v1/{workspace}/workflow/{slug}/"

payload = {
    "name": "Welcome Email",
    "description": "Sends welcome email to new users",
    "category": "transactional",
    "trigger_type": "api",
    "tags": ["welcome", "onboarding"],
    "tree": { "nodes": [
            {
                "name": "Send Email",
                "node_type": "send_email",
                "properties": { "template": "welcome-email-template" },
                "description": "Send welcome email to new users"
            }
        ] }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Welcome Email',
    description: 'Sends welcome email to new users',
    category: 'transactional',
    trigger_type: 'api',
    tags: ['welcome', 'onboarding'],
    tree: {
      nodes: [
        {
          name: 'Send Email',
          node_type: 'send_email',
          properties: {template: 'welcome-email-template'},
          description: 'Send welcome email to new users'
        }
      ]
    }
  })
};

fetch('https://management-api.suprsend.com/v1/{workspace}/workflow/{slug}/', 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 => "https://management-api.suprsend.com/v1/{workspace}/workflow/{slug}/",
  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' => 'Welcome Email',
    'description' => 'Sends welcome email to new users',
    'category' => 'transactional',
    'trigger_type' => 'api',
    'tags' => [
        'welcome',
        'onboarding'
    ],
    'tree' => [
        'nodes' => [
                [
                                'name' => 'Send Email',
                                'node_type' => 'send_email',
                                'properties' => [
                                                                'template' => 'welcome-email-template'
                                ],
                                'description' => 'Send welcome email to new users'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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 := "https://management-api.suprsend.com/v1/{workspace}/workflow/{slug}/"

	payload := strings.NewReader("{\n  \"name\": \"Welcome Email\",\n  \"description\": \"Sends welcome email to new users\",\n  \"category\": \"transactional\",\n  \"trigger_type\": \"api\",\n  \"tags\": [\n    \"welcome\",\n    \"onboarding\"\n  ],\n  \"tree\": {\n    \"nodes\": [\n      {\n        \"name\": \"Send Email\",\n        \"node_type\": \"send_email\",\n        \"properties\": {\n          \"template\": \"welcome-email-template\"\n        },\n        \"description\": \"Send welcome email to new users\"\n      }\n    ]\n  }\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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("https://management-api.suprsend.com/v1/{workspace}/workflow/{slug}/")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Welcome Email\",\n  \"description\": \"Sends welcome email to new users\",\n  \"category\": \"transactional\",\n  \"trigger_type\": \"api\",\n  \"tags\": [\n    \"welcome\",\n    \"onboarding\"\n  ],\n  \"tree\": {\n    \"nodes\": [\n      {\n        \"name\": \"Send Email\",\n        \"node_type\": \"send_email\",\n        \"properties\": {\n          \"template\": \"welcome-email-template\"\n        },\n        \"description\": \"Send welcome email to new users\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://management-api.suprsend.com/v1/{workspace}/workflow/{slug}/")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Welcome Email\",\n  \"description\": \"Sends welcome email to new users\",\n  \"category\": \"transactional\",\n  \"trigger_type\": \"api\",\n  \"tags\": [\n    \"welcome\",\n    \"onboarding\"\n  ],\n  \"tree\": {\n    \"nodes\": [\n      {\n        \"name\": \"Send Email\",\n        \"node_type\": \"send_email\",\n        \"properties\": {\n          \"template\": \"welcome-email-template\"\n        },\n        \"description\": \"Send welcome email to new users\"\n      }\n    ]\n  }\n}"

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

{
  "name": "Welcome Email",
  "description": "Sends welcome email to new users",
  "category": "transactional",
  "trigger_type": "api",
  "tags": [
    "welcome",
    "onboarding"
  ],
  "tree": {
    "nodes": [
      {
        "name": "Send Email",
        "node_type": "send_email",
        "properties": {
          "template": "welcome-email-template"
        },
        "description": "Send welcome email to new users"
      }
    ]
  },
  "validation_result": {
    "is_valid": true,
    "errors": []
  }
}

{
  "code": 123,
  "error_code": "<string>",
  "type": "<string>",
  "message": "<string>",
  "detail": "<string>"
}

{
  "code": 401,
  "error_code": "authentication_failed",
  "type": "AuthenticationFailed",
  "message": "Invalid service token.",
  "detail": "Invalid service token."
}

{
  "code": 404,
  "error_code": "not_found",
  "type": "NotFound",
  "message": "workspace 'demo' not found",
  "detail": "workspace 'demo' not found"
}

API Reference

WORKSPACE & AUTH KEYS

WORKFLOWS

SCHEMAS

EVENTS

CATEGORIES

TRANSLATIONS

TEMPLATES

Authorizations

Path Parameters

Query Parameters

Body

Response