Typescript (SDK)

import { Crevio } from "@crevio/sdk";

const crevio = new Crevio({
  apiKey: process.env["CREVIO_API_KEY"] ?? "",
});

async function run() {
  const result = await crevio.sequences.create({
    name: "<value>",
  });

  console.log(result);
}

run();

curl --request POST \
  --url https://api.crevio.co/v1/sequences \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "exit": {
    "product_ids": [
      "<string>"
    ],
    "tag_ids": [
      "<string>"
    ],
    "on_reply": true
  },
  "send_days": [],
  "from": "<string>",
  "reply_to": "<string>",
  "styled": true,
  "metadata": {},
  "steps": [
    {
      "subject": "<string>",
      "body": "<string>",
      "preview_text": "<string>"
    }
  ]
}
'

import requests

url = "https://api.crevio.co/v1/sequences"

payload = {
    "name": "<string>",
    "exit": {
        "product_ids": ["<string>"],
        "tag_ids": ["<string>"],
        "on_reply": True
    },
    "send_days": [],
    "from": "<string>",
    "reply_to": "<string>",
    "styled": True,
    "metadata": {},
    "steps": [
        {
            "subject": "<string>",
            "body": "<string>",
            "preview_text": "<string>"
        }
    ]
}
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: '<string>',
    exit: {product_ids: ['<string>'], tag_ids: ['<string>'], on_reply: true},
    send_days: [],
    from: '<string>',
    reply_to: '<string>',
    styled: true,
    metadata: {},
    steps: [
      {
        subject: '<string>',
        body: JSON.stringify('<string>'),
        preview_text: '<string>'
      }
    ]
  })
};

fetch('https://api.crevio.co/v1/sequences', 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://api.crevio.co/v1/sequences",
  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>',
    'exit' => [
        'product_ids' => [
                '<string>'
        ],
        'tag_ids' => [
                '<string>'
        ],
        'on_reply' => true
    ],
    'send_days' => [
        
    ],
    'from' => '<string>',
    'reply_to' => '<string>',
    'styled' => true,
    'metadata' => [
        
    ],
    'steps' => [
        [
                'subject' => '<string>',
                'body' => '<string>',
                'preview_text' => '<string>'
        ]
    ]
  ]),
  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://api.crevio.co/v1/sequences"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"exit\": {\n    \"product_ids\": [\n      \"<string>\"\n    ],\n    \"tag_ids\": [\n      \"<string>\"\n    ],\n    \"on_reply\": true\n  },\n  \"send_days\": [],\n  \"from\": \"<string>\",\n  \"reply_to\": \"<string>\",\n  \"styled\": true,\n  \"metadata\": {},\n  \"steps\": [\n    {\n      \"subject\": \"<string>\",\n      \"body\": \"<string>\",\n      \"preview_text\": \"<string>\"\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://api.crevio.co/v1/sequences")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"exit\": {\n    \"product_ids\": [\n      \"<string>\"\n    ],\n    \"tag_ids\": [\n      \"<string>\"\n    ],\n    \"on_reply\": true\n  },\n  \"send_days\": [],\n  \"from\": \"<string>\",\n  \"reply_to\": \"<string>\",\n  \"styled\": true,\n  \"metadata\": {},\n  \"steps\": [\n    {\n      \"subject\": \"<string>\",\n      \"body\": \"<string>\",\n      \"preview_text\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.crevio.co/v1/sequences")

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\": \"<string>\",\n  \"exit\": {\n    \"product_ids\": [\n      \"<string>\"\n    ],\n    \"tag_ids\": [\n      \"<string>\"\n    ],\n    \"on_reply\": true\n  },\n  \"send_days\": [],\n  \"from\": \"<string>\",\n  \"reply_to\": \"<string>\",\n  \"styled\": true,\n  \"metadata\": {},\n  \"steps\": [\n    {\n      \"subject\": \"<string>\",\n      \"body\": \"<string>\",\n      \"preview_text\": \"<string>\"\n    }\n  ]\n}"

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

{
  "object": "sequence",
  "id": "<string>",
  "name": "<string>",
  "status": "draft",
  "trigger": {
    "event": "manual",
    "tag_id": "<string>",
    "product_ids": [
      "<string>"
    ]
  },
  "exit": {
    "on_purchase": "none",
    "product_ids": [
      "<string>"
    ],
    "tag_ids": [
      "<string>"
    ],
    "on_reply": true
  },
  "send_days": [
    "sun"
  ],
  "from": "<string>",
  "reply_to": "<string>",
  "styled": true,
  "steps": [
    {
      "object": "sequence_step",
      "id": "<string>",
      "sequence": "<string>",
      "position": 123,
      "subject": "<string>",
      "preview_text": "<string>",
      "body": "<string>",
      "delay": {
        "amount": 1,
        "unit": "minutes"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "bad_request",
    "message": "The request was malformed or contained invalid parameters"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "authentication_required",
    "message": "You did not provide an API key."
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "forbidden",
    "message": "You do not have permission to perform this action"
  }
}

{
  "error": {
    "type": "validation_error",
    "code": "validation_failed",
    "message": "Email is required",
    "errors": {
      "email": [
        "can't be blank"
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "rate_limit_exceeded",
    "message": "Too many requests. Please retry later."
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred"
  }
}

Sequences

Create a sequence

Creates a timed email series as a draft, with its steps in send order. Each step waits its delay after the previous send (after enrolling, for the first). Nothing sends until you activate it with POST /sequences/{id}/activate.

Pick the trigger that enrolls people: customer.tag_added with a form’s tag is the newsletter welcome series (forms apply their tags after double opt-in), lead.created catches every new lead, order.paid follows a purchase, and manual enrolls only through POST /sequences/{sequence_id}/enrollments. Set exit rules for when people leave early; a sales sequence should set exit.on_purchase.

Sending one email to many people now? Use POST /broadcasts.

POST

sequences

Typescript (SDK)

import { Crevio } from "@crevio/sdk";

const crevio = new Crevio({
  apiKey: process.env["CREVIO_API_KEY"] ?? "",
});

async function run() {
  const result = await crevio.sequences.create({
    name: "<value>",
  });

  console.log(result);
}

run();

curl --request POST \
  --url https://api.crevio.co/v1/sequences \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "exit": {
    "product_ids": [
      "<string>"
    ],
    "tag_ids": [
      "<string>"
    ],
    "on_reply": true
  },
  "send_days": [],
  "from": "<string>",
  "reply_to": "<string>",
  "styled": true,
  "metadata": {},
  "steps": [
    {
      "subject": "<string>",
      "body": "<string>",
      "preview_text": "<string>"
    }
  ]
}
'

import requests

url = "https://api.crevio.co/v1/sequences"

payload = {
    "name": "<string>",
    "exit": {
        "product_ids": ["<string>"],
        "tag_ids": ["<string>"],
        "on_reply": True
    },
    "send_days": [],
    "from": "<string>",
    "reply_to": "<string>",
    "styled": True,
    "metadata": {},
    "steps": [
        {
            "subject": "<string>",
            "body": "<string>",
            "preview_text": "<string>"
        }
    ]
}
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: '<string>',
    exit: {product_ids: ['<string>'], tag_ids: ['<string>'], on_reply: true},
    send_days: [],
    from: '<string>',
    reply_to: '<string>',
    styled: true,
    metadata: {},
    steps: [
      {
        subject: '<string>',
        body: JSON.stringify('<string>'),
        preview_text: '<string>'
      }
    ]
  })
};

fetch('https://api.crevio.co/v1/sequences', 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://api.crevio.co/v1/sequences",
  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>',
    'exit' => [
        'product_ids' => [
                '<string>'
        ],
        'tag_ids' => [
                '<string>'
        ],
        'on_reply' => true
    ],
    'send_days' => [
        
    ],
    'from' => '<string>',
    'reply_to' => '<string>',
    'styled' => true,
    'metadata' => [
        
    ],
    'steps' => [
        [
                'subject' => '<string>',
                'body' => '<string>',
                'preview_text' => '<string>'
        ]
    ]
  ]),
  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://api.crevio.co/v1/sequences"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"exit\": {\n    \"product_ids\": [\n      \"<string>\"\n    ],\n    \"tag_ids\": [\n      \"<string>\"\n    ],\n    \"on_reply\": true\n  },\n  \"send_days\": [],\n  \"from\": \"<string>\",\n  \"reply_to\": \"<string>\",\n  \"styled\": true,\n  \"metadata\": {},\n  \"steps\": [\n    {\n      \"subject\": \"<string>\",\n      \"body\": \"<string>\",\n      \"preview_text\": \"<string>\"\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://api.crevio.co/v1/sequences")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"exit\": {\n    \"product_ids\": [\n      \"<string>\"\n    ],\n    \"tag_ids\": [\n      \"<string>\"\n    ],\n    \"on_reply\": true\n  },\n  \"send_days\": [],\n  \"from\": \"<string>\",\n  \"reply_to\": \"<string>\",\n  \"styled\": true,\n  \"metadata\": {},\n  \"steps\": [\n    {\n      \"subject\": \"<string>\",\n      \"body\": \"<string>\",\n      \"preview_text\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.crevio.co/v1/sequences")

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\": \"<string>\",\n  \"exit\": {\n    \"product_ids\": [\n      \"<string>\"\n    ],\n    \"tag_ids\": [\n      \"<string>\"\n    ],\n    \"on_reply\": true\n  },\n  \"send_days\": [],\n  \"from\": \"<string>\",\n  \"reply_to\": \"<string>\",\n  \"styled\": true,\n  \"metadata\": {},\n  \"steps\": [\n    {\n      \"subject\": \"<string>\",\n      \"body\": \"<string>\",\n      \"preview_text\": \"<string>\"\n    }\n  ]\n}"

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

{
  "object": "sequence",
  "id": "<string>",
  "name": "<string>",
  "status": "draft",
  "trigger": {
    "event": "manual",
    "tag_id": "<string>",
    "product_ids": [
      "<string>"
    ]
  },
  "exit": {
    "on_purchase": "none",
    "product_ids": [
      "<string>"
    ],
    "tag_ids": [
      "<string>"
    ],
    "on_reply": true
  },
  "send_days": [
    "sun"
  ],
  "from": "<string>",
  "reply_to": "<string>",
  "styled": true,
  "steps": [
    {
      "object": "sequence_step",
      "id": "<string>",
      "sequence": "<string>",
      "position": 123,
      "subject": "<string>",
      "preview_text": "<string>",
      "body": "<string>",
      "delay": {
        "amount": 1,
        "unit": "minutes"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "bad_request",
    "message": "The request was malformed or contained invalid parameters"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "authentication_required",
    "message": "You did not provide an API key."
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "forbidden",
    "message": "You do not have permission to perform this action"
  }
}

{
  "error": {
    "type": "validation_error",
    "code": "validation_failed",
    "message": "Email is required",
    "errors": {
      "email": [
        "can't be blank"
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "rate_limit_exceeded",
    "message": "Too many requests. Please retry later."
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred"
  }
}

Authorizations

Authorization

string

header

required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key

string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Body

application/json

name

string

required

Internal name, shown in the dashboard.

trigger

object

Show child attributes

exit

object

Show child attributes

send_days

enum<string>[]

Weekdays a step may go out, in the business's time zone. Defaults to every day.

Available options:

sun,

mon,

tue,

wed,

thu,

fri,

sat

from

string | null

Sender address on the account's verified domain. Defaults to the account's sending address.

reply_to

string | null

Where replies go. Defaults to the account's Crevio inbox when exit.on_reply is on, otherwise the support email.

styled

boolean

Wrap each email in the branded layout. Defaults to true.

metadata

object

Caller-owned key/value pairs.

Show child attributes

steps

object[]

The emails in send order. Edit them later through the step endpoints.

Maximum array length: 50

Show child attributes

Response

The created sequence

object

enum<string>

required

Available options:

sequence

string

required

name

string

required

status

enum<string>

required

Available options:

draft,

active,

paused

trigger

object

required

Show child attributes

exit

object

required

Show child attributes

send_days

enum<string>[]

required

Weekdays a step may go out, in the business's time zone. A step due on another day waits for the next allowed day at the same local time.

Available options:

sun,

mon,

tue,

wed,

thu,

fri,

sat

from

string | null

required

reply_to

string | null

required

styled

boolean

required

steps

object[]

required

Live steps in send order.

Show child attributes

metadata

object

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

Overview

Products & catalog

Selling & orders

Customers & leads

Marketing

Website & content

Scheduling & bookings

Calls & phone

AI & automation

Media library

Business & formation

Account & platform

Create a sequence

Authorizations

Headers

Body

Response