Create a cadence membership

POST 
https://api.salesloft.com/v2/cadence_memberships

Adds a person to a cadence. person_id and cadence_id are required, and must be visible to the authenticated user. user_id will default to the authenticated user, but can be set to any visible user on the authenticated team.

A person cannot be added to a cadence on behalf of a teammate unless the cadence is a team cadence, the cadence is owned by the teammate, or the teammate has the Personal Cadence Admin permission.

Request

Query Parameters

person_id integerrequired

ID of the person to create a cadence membership for

cadence_id integerrequired

ID of the cadence to create a cadence membership for

user_id integer

ID of the user to create a cadence membership for. The associated cadence must be owned by the user, or it must be a team cadence

step_id integer

ID of the step on which the person should start the cadence. Start on first step is the default behavior without this parameter.

task_id integer

ID of the task that causes the requested action. The task will be completed automatically upon success

multipart/form-data

Bodyrequired

object

Responses

200

Success

application/json

Schema

Schema

idinteger
Cadence membership ID
Example: 1
added_atdate-time
Datetime of when the person was last added to this cadence
Example: 2024-01-01T00:00:00.000000+00:00
created_atdate-time
Datetime of when the person was first added to this cadence
Example: 2024-01-01T00:00:00.000000+00:00
updated_atdate-time
Datetime of when the record was last updated
Example: 2024-01-01T00:00:00.000000+00:00
person_deletedboolean
Whether the associated person has since been deleted
Example: false
currently_on_cadenceboolean
Whether the person is currently on the cadence
Example: false
current_statestring
The current state of the person on the cadence. Possible values are:
processing: The person is being processed on a cadence. Cadence-related changes cannot be made at this time
staged: The person is waiting for the first step in the cadence to occur
active: The cadence has begun processing this person and is still in the process, but idle
scheduled: The cadence has begun processing this person and is still in the process, with an activity scheduled to occur
completed: The cadence has been completed for this person
removed: The person was manually or automatically removed from the cadence
removed_no_action: The person was removed from the cadence before any action occurred
reassigned: The person's cadence execution was transferred to a different user, ending this user's interaction
archived: The cadence this person belonged to has been archived and all actions and people were archived with it
Example: staged
cadence object
The cadence that the person is on
idinteger
Example: 1
_hrefstring
Example: https://api.salesloft.com/v2/cadences/1
person object
The person that is on the cadence
idinteger
Example: 2
_hrefstring
Example: https://api.salesloft.com/v2/people/2
user object
The user that is acting on the person in the cadence
idinteger
Example: 3
_hrefstring
Example: https://api.salesloft.com/v2/users/3
latest_action object
The most recent action associated with the record
idinteger
Example: 4
counts object
viewsinteger
The number of times emails sent from the cadence to the person were opened
Example: 10
clicksinteger
The number of times emails sent from the cadence to the person were clicked
Example: 5
repliesinteger
The number of times emails sent from the cadence to the person were replied to
Example: 2
callsinteger
The number of times a call was logged from the cadence to the person
Example: 2
sent_emailsinteger
The number of times emails were sent from the cadence to the person
Example: 4
bouncesinteger
The number of times emails sent from the cadence to the person bounced
Example: 0

Example (auto)

{
  "id": 1,
  "added_at": "2024-01-01T00:00:00.000000+00:00",
  "created_at": "2024-01-01T00:00:00.000000+00:00",
  "updated_at": "2024-01-01T00:00:00.000000+00:00",
  "person_deleted": false,
  "currently_on_cadence": false,
  "current_state": "staged",
  "cadence": {
    "id": 1,
    "_href": "https://api.salesloft.com/v2/cadences/1"
  },
  "person": {
    "id": 2,
    "_href": "https://api.salesloft.com/v2/people/2"
  },
  "user": {
    "id": 3,
    "_href": "https://api.salesloft.com/v2/users/3"
  },
  "latest_action": {
    "id": 4
  },
  "counts": {
    "views": 10,
    "clicks": 5,
    "replies": 2,
    "calls": 2,
    "sent_emails": 4,
    "bounces": 0
  }
}

• 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("developer.salesloft.com")
payload = ''
headers = {
  'Content-Type': 'multipart/form-data',
  'Accept': 'application/json',
  'Authorization': 'Bearer <token>'
}
conn.request("POST", "/v2/cadence_memberships", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Request Collapse all

Base URL

https://api.salesloft.com

Auth

Bearer Token

Parameters

person_id — queryrequired

cadence_id — queryrequired

user_id — query

step_id — query

task_id — query

Body required

ResponseClear

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