Replace a campaign's sequence

PUT/v1/campaigns/{campaign_id}/sequence

Scope: campaigns:write

Replaces the campaign's whole sequence. To change one step, use Update a sequence step instead.

Send expected_updated_at, the campaign's updated_at as you last read it, to write only if nothing has changed the campaign since. If it has, nothing is written and the request answers 409 SEQUENCE_MODIFIED; retrieve the campaign again and retry. Without it, the write always lands.

A sequence is validated before it's saved:

variation_a is required and variation_b is optional. Each is a list of steps.
Step types are view_profile, linkedin_connection, conditional, linkedin_message and email.
A linkedin_connection step must be followed immediately by a conditional step with branches.yes and branches.no. Conditionals nest at most two deep.
linkedin_message steps are only allowed inside a yes branch.
email steps need subject and content.
delay is a number of days from 0 to 90.
Every step needs a unique integer id, and a sequence has at most 40 steps.

The easiest valid starting point is a sequence template.

Headers

AuthorizationstringRequired
Bearer followed by a space and your API key, for example Bearer vk_….

Path parameters

campaign_idstring · uuidRequired
ID of the campaign.

Request body

sequenceobjectRequired
Full sequence object with variation_a (and optionally variation_b) step arrays
expected_updated_atstring or null
The campaign's updated_at as you last read it. If it has changed since, nothing is written and the answer is 409 SEQUENCE_MODIFIED.
at most 2,000 characters

Response

200

messagestringRequired
campaign_idstring or null
successboolean
Default true

Errors

Errors share one JSON body: success, error, message, optional details, and request_id.

Status	Code	Meaning
400	VALIDATION_ERROR	The request didn't match the endpoint's schema: a missing or malformed field, a bad query parameter, or a value out of range. `details.errors` lists each failing field with its `field`, `message` and `type`.
400	SEQUENCE_VALIDATION_FAILED	The sequence breaks a structural rule, such as an unknown step type or a `linkedin_connection` step without a `conditional` after it. The message lists every rule that failed.
401	UNAUTHORIZED	The `Authorization` header is missing or malformed, or the API key is unknown or has been deactivated.
401	API_KEY_EXPIRED	The API key is past its expiry date. Create a new key in the Victoria AI app.
403	INSUFFICIENT_SCOPE	The API key doesn't have the scope this endpoint requires, such as `leads:write`.
403	ORGANIZATION_DEACTIVATED	The organization that owns this API key has been deactivated.
404	CAMPAIGN_NOT_FOUND	No campaign with this ID exists in your organization.
404	NOT_FOUND	No endpoint matches the path. A resource ID in the path that isn't a valid UUID also answers `NOT_FOUND`.
409	SEQUENCE_MODIFIED	The sequence changed after it was read. Retrieve the campaign again and retry.
413	PAYLOAD_TOO_LARGE	The request body is larger than 1 MB.
429	RATE_LIMITED	Too many requests for this API key: more than 100 a minute to one endpoint, or 600 a minute in total. Retry after the number of seconds in the `Retry-After` header. See Rate limits.
500	INTERNAL_ERROR	Something failed on our side. The response never includes internal details; quote its `request_id` when you contact support.
503	UPSTREAM_TIMEOUT	A service the API depends on timed out. The request is safe to retry.
503	AUTH_UNAVAILABLE	The API key couldn't be checked because the authentication service was unavailable. The request is safe to retry.

Response headers

Header	Description
`X-Request-ID`	Correlation ID for the request, also returned as `request_id` in error bodies. Send your own `X-Request-ID`, up to 128 letters, digits, `.`, `_`, `:` or `-`, and it's used instead.
`RateLimit-Limit`	Requests allowed to this endpoint per minute.
`RateLimit-Remaining`	Requests you can still send to this endpoint right now.
`RateLimit-Reset`	Seconds until the endpoint's full limit is available again.
`Retry-After`	On a `429`: seconds to wait before retrying.

Request

curl -X PUT "https://api.versionseven.ai/v1/campaigns/550e8400-e29b-41d4-a716-446655440000/sequence" \
  -H "Authorization: Bearer $VICTORIA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "sequence": {
    "variation_a": [
      {
        "id": 1,
        "type": "view_profile",
        "delay": 1
      },
      {
        "id": 2,
        "type": "linkedin_connection",
        "message": "Hi {first_name}, I work with sales teams and would like to connect.",
        "delay": 5
      },
      {
        "id": 3,
        "type": "conditional",
        "conditionalType": "linkedin_connected",
        "isConditional": true,
        "delay": 5,
        "branches": {
          "yes": [
            {
              "id": 4,
              "type": "linkedin_message",
              "message": "Thanks for connecting, {first_name}. Are you the right person to talk to about how {company} books sales meetings?",
              "delay": 3
            },
            {
              "id": 5,
              "type": "email",
              "subject": "Following up, {first_name}",
              "content": "Hi {first_name},\n\nI sent you a note on LinkedIn. Would a short call next week be useful?\n\nJane",
              "delay": 0
            }
          ],
          "no": [
            {
              "id": 6,
              "type": "email",
              "subject": "Question about {company}",
              "content": "Hi {first_name},\n\nAre you the right person to talk to about how {company} books sales meetings?\n\nThanks,\nJane",
              "delay": 3
            },
            {
              "id": 7,
              "type": "email",
              "subject": "Closing the loop",
              "content": "Hi {first_name},\n\nI haven'\''t heard back, so I'\''ll assume the timing isn'\''t right. If that changes, just reply to this email.\n\nJane",
              "delay": 0
            }
          ]
        }
      }
    ],
    "variation_b": []
  }
}'

const response = await fetch("https://api.versionseven.ai/v1/campaigns/550e8400-e29b-41d4-a716-446655440000/sequence", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.VICTORIA_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "sequence": {
      "variation_a": [
        {
          "id": 1,
          "type": "view_profile",
          "delay": 1
        },
        {
          "id": 2,
          "type": "linkedin_connection",
          "message": "Hi {first_name}, I work with sales teams and would like to connect.",
          "delay": 5
        },
        {
          "id": 3,
          "type": "conditional",
          "conditionalType": "linkedin_connected",
          "isConditional": true,
          "delay": 5,
          "branches": {
            "yes": [
              {
                "id": 4,
                "type": "linkedin_message",
                "message": "Thanks for connecting, {first_name}. Are you the right person to talk to about how {company} books sales meetings?",
                "delay": 3
              },
              {
                "id": 5,
                "type": "email",
                "subject": "Following up, {first_name}",
                "content": "Hi {first_name},\n\nI sent you a note on LinkedIn. Would a short call next week be useful?\n\nJane",
                "delay": 0
              }
            ],
            "no": [
              {
                "id": 6,
                "type": "email",
                "subject": "Question about {company}",
                "content": "Hi {first_name},\n\nAre you the right person to talk to about how {company} books sales meetings?\n\nThanks,\nJane",
                "delay": 3
              },
              {
                "id": 7,
                "type": "email",
                "subject": "Closing the loop",
                "content": "Hi {first_name},\n\nI haven't heard back, so I'll assume the timing isn't right. If that changes, just reply to this email.\n\nJane",
                "delay": 0
              }
            ]
          }
        }
      ],
      "variation_b": []
    }
  }),
});

const data = await response.json();

import os

import requests

response = requests.put(
    "https://api.versionseven.ai/v1/campaigns/550e8400-e29b-41d4-a716-446655440000/sequence",
    headers={
        "Authorization": f"Bearer {os.environ['VICTORIA_API_KEY']}",
    },
    json={
        "sequence": {
            "variation_a": [
                {
                    "id": 1,
                    "type": "view_profile",
                    "delay": 1,
                },
                {
                    "id": 2,
                    "type": "linkedin_connection",
                    "message": "Hi {first_name}, I work with sales teams and would like to connect.",
                    "delay": 5,
                },
                {
                    "id": 3,
                    "type": "conditional",
                    "conditionalType": "linkedin_connected",
                    "isConditional": True,
                    "delay": 5,
                    "branches": {
                        "yes": [
                            {
                                "id": 4,
                                "type": "linkedin_message",
                                "message": "Thanks for connecting, {first_name}. Are you the right person to talk to about how {company} books sales meetings?",
                                "delay": 3,
                            },
                            {
                                "id": 5,
                                "type": "email",
                                "subject": "Following up, {first_name}",
                                "content": "Hi {first_name},\n\nI sent you a note on LinkedIn. Would a short call next week be useful?\n\nJane",
                                "delay": 0,
                            },
                        ],
                        "no": [
                            {
                                "id": 6,
                                "type": "email",
                                "subject": "Question about {company}",
                                "content": "Hi {first_name},\n\nAre you the right person to talk to about how {company} books sales meetings?\n\nThanks,\nJane",
                                "delay": 3,
                            },
                            {
                                "id": 7,
                                "type": "email",
                                "subject": "Closing the loop",
                                "content": "Hi {first_name},\n\nI haven't heard back, so I'll assume the timing isn't right. If that changes, just reply to this email.\n\nJane",
                                "delay": 0,
                            },
                        ],
                    },
                },
            ],
            "variation_b": [],
        },
    },
)
data = response.json()

Response

{
  "message": "string",
  "campaign_id": "550e8400-e29b-41d4-a716-446655440000",
  "success": true
}