Get Sequences API

Retrieve available message sequences for campaigns. (Coming soon)

Get Sequences API

Retrieve available message sequences (and their types) that can be used in the Request Message Generation API. Show these sequences to your users to help them choose the best sequence for their campaign.

Each sequence is associated with a role, industry, geography, and objective - any of which can be used by the user to choose which sequence to use.

These sequences are generated by Upscale based on best practices for LinkedIn outreach - and what we are seeing work best. You can also customise a sequence to your own needs; the Request Message Generation API only needs the list of all message types you want to use in the campaign.

Endpoint

MethodPath
GET/get_sequences (placeholder - details to be confirmed)

Headers: Api-Key: your_api_key_here, Content-Type: application/json

Request

Request parameters

ParameterTypeDescription
(placeholder)-Request parameters to be documented.

Notes

  • Placeholder: request notes and example to be added.

Example request

curl -X GET "https://app.upscaleoutreach.com/api/v2/get_sequences" \
  -H "Api-Key: your_api_key_here" \
  -H "Content-Type: application/json"

Response

On success (200), the response returns the list of available sequences. Placeholder structure below - to be updated with actual fields.

200 OK - Success

Error response examples

Unauthorized (401):

200 OK — Success

{
  "sequences": [
    {
      "id": "placeholder",
      "name": "Placeholder sequence",
      "message_types": ["connection_request", "first_follow_up"],
      "role": "sales",
      "industry": "technology",
      "geography": "north_america",
      "objective": "demonstrate expertise"
    }
  ]
}