Update sequence

Update a sequence's name, steps, or exit conditions. Steps can only be modified while the sequence is draft or paused.

Authorization

AuthorizationBearer <token>

API key authentication - use your Zernio API key as a Bearer token

In: header

Path Parameters

sequenceIdstring

Request Body

name?string

description?string

steps?

Replace the full step list. Only allowed while the sequence is draft or paused.

exitOnReply?boolean

exitOnUnsubscribe?boolean

Response Body

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.sequences.updateSequence({  path: {    sequenceId: 'sequence_abc123',  },  body: {    name: 'Example',    description: 'Hello, world!',    steps: [      {        order: 0,        delayMinutes: 0,      },    ],  },});console.log(data);

{
  "success": true,
  "sequence": {
    "id": "string",
    "name": "string",
    "description": "string",
    "status": "string",
    "steps": [
      {}
    ],
    "exitOnReply": true,
    "exitOnUnsubscribe": true,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "Unauthorized"
}

{
  "error": "Not found"
}

Authorization

AuthorizationBearer <token>

API key authentication - use your Zernio API key as a Bearer token

In: header

Path Parameters

sequenceIdstring

Request Body

name?string

description?string

steps?

Replace the full step list. Only allowed while the sequence is draft or paused.

exitOnReply?boolean

exitOnUnsubscribe?boolean

Response Body

application/json

import Zernio from '@zernio/node';

const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });

const { data } = await zernio.sequences.updateSequence({
  path: {
    sequenceId: 'sequence_abc123',
  },
  body: {
    name: 'Example',
    description: 'Hello, world!',
    steps: [
      {
        order: 0,
        delayMinutes: 0,
      },
    ],
  },
});
console.log(data);

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.sequences.updateSequence({  path: {    sequenceId: 'sequence_abc123',  },  body: {    name: 'Example',    description: 'Hello, world!',    steps: [      {        order: 0,        delayMinutes: 0,      },    ],  },});console.log(data);

{
  "success": true,
  "sequence": {
    "id": "string",
    "name": "string",
    "description": "string",
    "status": "string",
    "steps": [
      {}
    ],
    "exitOnReply": true,
    "exitOnUnsubscribe": true,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "Unauthorized"
}

{
  "error": "Not found"
}

Update sequence

200application/json

401application/json

404application/json

Update sequence

200application/json

401application/json

404application/json

application/json

application/json

application/json

application/json

application/json

application/json