Skip to main content

Create a cadence membership

POST 
/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

Responses​

Success

Schema
    id integer

    Cadence membership ID

    added_at date-time

    Datetime of when the person was last added to this cadence

    created_at date-time

    Datetime of when the person was first added to this cadence

    updated_at date-time

    Datetime of when the record was last updated

    person_deleted boolean

    Whether the associated person has since been deleted

    currently_on_cadence boolean

    Whether the person is currently on the cadence

    current_state string

    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

    cadence object

    The cadence that the person is on

    id integer
    _href string
    person object

    The person that is on the cadence

    id integer
    _href string
    user object

    The user that is acting on the person in the cadence

    id integer
    _href string
    latest_action object

    The most recent action associated with the record

    id integer
    counts object
    views integer

    The number of times emails sent from the cadence to the person were opened

    clicks integer

    The number of times emails sent from the cadence to the person were clicked

    replies integer

    The number of times emails sent from the cadence to the person were replied to

    calls integer

    The number of times a call was logged from the cadence to the person

    sent_emails integer

    The number of times emails were sent from the cadence to the person

    bounces integer

    The number of times emails sent from the cadence to the person bounced

Loading...