Salesloft

Activate a draft cadence | Salesloft API

The Salesloft API endpoint `POST /v2/cadences/:cadence_id/activate` transitions a draft cadence to active status, returning detailed cadence metadata upon success, but returns an error if the team's cadence approval flow is enabled, in which case the request review endpoint must be used instead.

Skip to main content

Activate a draft cadence

POST https://api.salesloft.com/v2/cadences/:cadence_id/activate

Transitions a draft cadence to active. Returns an error if the team has the cadence approval flow setting enabled — use the request review endpoint instead.

Request

Path Parameters

cadence_id integerrequired

Cadence ID

  • multipart/form-data

Body required

object

Responses

  • 201

Success

  • application/json

  • Schema

  • Example (auto)

Schema

id integer

ID of cadence

Example: 1

created_at date-time

Datetime of when the cadence was created

Example: 2026-01-01T00:00:00.000000+00:00

updated_at date-time

Datetime of when the cadence was last updated

Example: 2026-01-01T00:00:00.000000+00:00

archived_at date-time

Datetime of when the cadence was archived, if archived

Example: 2026-01-01T00:00:00.000000+00:00

latest_active_date date

Date of when the cadence was last used

Example: 2027-01-01

team_cadence boolean

Whether this cadence is a team cadence. A team cadence is created by an admin and can be run by all users

Example: false

shared boolean

Whether this cadence is visible to team members (shared)

Example: false

archived boolean

Whether this cadence is archived

Example: false

remove_bounces_enabled boolean

Whether this cadence is configured to automatically remove people who have bounced

Example: true

remove_replies_enabled boolean

Whether this cadence is configured to automatically remove people who have replied

Example: true

opt_out_link_included boolean

Whether this cadence is configured to include an opt-out link by default

Example: true

draft boolean

Whether this cadence is in draft mode

Example: false

override_contact_restrictions boolean

Whether this cadence is an Operational Cadence. An operational cadence is only created by an admin and accounts with the correct permission

Example: false

cadence_framework_id integer

ID of the cadence framework used to create steps for the cadence

Example: 1

archived_by string

Name or email of the user who archived the cadence

Example: John

knowledge_library_document_ids integer[]

IDs of knowledge library documents associated with this cadence

Example:[1,2,3]

cadence_function string

The use case of the cadence. Possible values are:

outbound: Denotes an outbound cadence, typically for sales purposes

inbound: Denotes an inbound sales cadence

event: Denotes a cadence used for an upcoming event

other: Denotes a cadence outside of the standard process

Example: outbound

name string

Cadence name

Example: Prospecting - VP of Sales

external_identifier string

Cadence External ID

Example: This is my external id

tags string[]

All tags applied to this cadence

Example:["7-23-2017","dreamforce"]

current_state string

The state of the Cadence. Read Only. Valid states are: draft, pending_review, active, archived, expired, deleted

Example: active

creator object

User that created this cadence

id integer

Example: 1

_href string

Example: https://api.salesloft.com/v2/users/1

owner object

User that is marked as the owner of this cadence

id integer

Example: 1

_href string

Example: https://api.salesloft.com/v2/users/1

bounced_stage object

Stage set when person on cadence bounces

id integer

Example: 1

_href string

Example: https://api.salesloft.com/v2/person_stages/1

replied_stage object

Stage set when person on cadence replies

id integer

Example: 2

_href string

Example: https://api.salesloft.com/v2/person_stages/2

added_stage object

Stage set when person is added to cadence

id integer

Example: 3

_href string

Example: https://api.salesloft.com/v2/person_stages/3

finished_stage object

Stage set when person is finished with cadence

id integer

Example: 3

_href string

Example: https://api.salesloft.com/v2/person_stages/3

cadence_priority object

Priority of the cadence

id integer

Example: 2

_href string

Example: https://api.salesloft.com/v2/cadence_priorities

groups object[]

Groups to which this cadence is assigned, if any

Array [

id integer

Example: 921

_href string

Example: https://api.salesloft.com/v2/groups/921

]

counts object

cadence_people integer

The number of people that have ever been added to the cadence

Example: 59

people_acted_on_count integer

The number of people that have been skipped, scheduled, or advanced in a cadence

Example: 1

target_daily_people integer

The user defined target for number of people to add to the cadence each day

Example: 10

opportunities_created integer

The number of opportunities created and attributed to the cadence

Example: 10

meetings_booked integer

The number of meetings booked and attributed to the cadence

Example: 10

{
  "id": 1,
  "created_at": "2026-01-01T00:00:00.000000+00:00",
  "updated_at": "2026-01-01T00:00:00.000000+00:00",
  "archived_at": "2026-01-01T00:00:00.000000+00:00",
  "latest_active_date": "2027-01-01",
  "team_cadence": false,
  "shared": false,
  "archived": false,
  "remove_bounces_enabled": true,
  "remove_replies_enabled": true,
  "opt_out_link_included": true,
  "draft": false,
  "override_contact_restrictions": false,
  "cadence_framework_id": 1,
  "archived_by": "John",
  "knowledge_library_document_ids": [\
    1,\
    2,\
    3\
  ],
  "cadence_function": "outbound",
  "name": "Prospecting - VP of Sales",
  "external_identifier": "This is my external id",
  "tags": [\
    "7-23-2017",\
    "dreamforce"\
  ],
  "current_state": "active",
  "creator": {
    "id": 1,
    "_href": "https://api.salesloft.com/v2/users/1"
  },
  "owner": {
    "id": 1,
    "_href": "https://api.salesloft.com/v2/users/1"
  },
  "bounced_stage": {
    "id": 1,
    "_href": "https://api.salesloft.com/v2/person_stages/1"
  },
  "replied_stage": {
    "id": 2,
    "_href": "https://api.salesloft.com/v2/person_stages/2"
  },
  "added_stage": {
    "id": 3,
    "_href": "https://api.salesloft.com/v2/person_stages/3"
  },
  "finished_stage": {
    "id": 3,
    "_href": "https://api.salesloft.com/v2/person_stages/3"
  },
  "cadence_priority": {
    "id": 2,
    "_href": "https://api.salesloft.com/v2/cadence_priorities"
  },
  "groups": [\
    {\
      "id": 921,\
      "_href": "https://api.salesloft.com/v2/groups/921"\
    }\
  ],
  "counts": {
    "cadence_people": 59,
    "people_acted_on_count": 1,
    "target_daily_people": 10,
    "opportunities_created": 10,
    "meetings_booked": 10
  }
}

Authorization: oauth2

name: OAuth2type: oauth2scopes: cadences:writeflows: {
  "authorizationCode": {
    "authorizationUrl": "https://accounts.salesloft.com/oauth/authorize",
    "tokenUrl": "https://accounts.salesloft.com/oauth/token"
  }
}
  • python

  • curl

  • csharp

  • go

  • nodejs

  • ruby

  • php

  • java

  • powershell

  • dart

  • javascript

  • c

  • objective-c

  • ocaml

  • r

  • swift

  • kotlin

  • rust

  • HTTP.CLIENT

  • REQUESTS

import http.client

conn = http.client.HTTPSConnection("api.salesloft.com")
payload = ''
headers = {
  'Content-Type': 'multipart/form-data',
  'Accept': 'application/json',
  'Authorization': 'Bearer <token>'
}
conn.request("POST", "/v2/cadences/:cadence_id/activate", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Request Collapse all

Base URL

Edit

https://api.salesloft.com

Auth

Bearer Token

Parameters

cadence_id — pathrequired

Body required

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!