Launch a play in review: create its campaign and start it now, or at the next 8:00

POSTRequest

curl -X POST "https://prestigious-goldfish-661.convex.site/v1/autopilot/plays/$ID/launch" \
    -H "Authorization: Bearer $REACHIZ_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"when":"now"}'

Responses

200400401403404409429503

Response 200

Success

application/json

Example responseGenerated from schema

{
  "id": -9007199254740991,
  "rank": -9007199254740991,
  "name": "name",
  "angle": "angle",
  "pitch": "pitch",
  "why": "why",
  "chips": [
    "chips"
  ],
  "channel": "linkedin_email",
  "status": "designed",
  "startAt": "startAt",
  "campaignId": -9007199254740991,
  "listId": -9007199254740991,
  "sequence": [
    {
      "day": -9007199254740991,
      "kind": "invite",
      "subject": "subject",
      "text": "text"
    }
  ],
  "build": {
    "label": "label",
    "step": -9007199254740991,
    "of": -9007199254740991
  },
  "strategy": "strategy",
  "reaches": "reaches",
  "choices": [
    "choices"
  ],
  "audience": 0,
  "creditsPerLead": 0,
  "steps": [
    {
      "id": "id",
      "kind": "reaction",
      "delay": {
        "count": 0,
        "unit": "minutes"
      },
      "after": "previous",
      "text": "text",
      "subject": "subject",
      "reaction": "match"
    }
  ],
  "sample": [
    {
      "leadId": -9007199254740991,
      "name": "name",
      "title": "title",
      "company": "company",
      "headline": "headline",
      "summary": "summary",
      "imageUrl": "imageUrl",
      "linkedinUrl": "linkedinUrl",
      "location": "location",
      "industry": "industry",
      "fit": "good",
      "messages": [
        {
          "day": -9007199254740991,
          "kind": "invite",
          "subject": "subject",
          "text": "text"
        }
      ]
    }
  ],
  "log": [
    {
      "role": "user",
      "text": "text",
      "at": "at"
    }
  ],
  "working": "working",
  "launchedAt": "launchedAt"
}

Response 400

The request is not valid. error.fields lists each problem.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 401

The API key is missing or not valid.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 403

The key lacks the scope this route needs.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 404

The resource does not exist, or belongs to another account.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 409

The Idempotency-Key belongs to a different request, or the state does not allow this action.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 429

Too many requests.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 503

The service is busy. Retry with backoff.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Path parameters

• idnumberrequired

Request body

Required

Yes

Content type

• application/json

• whenstringrequired
  Allowed values: now, scheduled

  now starts the campaign at once; scheduled starts it at the next 8:00

• sendersnumber[]optional

  LinkedIn account ids to send from. Send the settings below together with senders; without senders the play launches with its defaults

• emailSendersnumber[]optional
• scheduleobjectoptional

  days: 0 is Sunday; start and end are HH:MM

  Show 4 properties

  • daysnumber[]required
  • startstringrequired
  • endstringrequired
  • timezonestringrequired
• dailyNewLeadsone of 2 variantsoptional

  Most new people per day; empty means as many as the senders can write to

  Show 2 variants

  • number
• skipsobjectoptional
  Show 3 properties

  • inOtherCampaignsbooleanrequired
  • contactedBeforebooleanrequired
  • alreadyConnectedbooleanrequired
• approveBeforeSendbooleanoptional

  Every message waits for approval, on this campaign and the ones built after it

Returns

Schema shown for 200 · application/json

• idnumber
• ranknumber
• namestring
• anglestring
• pitchstring
• whystring
• chipsstring[]
• channelstring
  Allowed values: linkedin_email, linkedin
• statusstring
  Allowed values: designed, finding, writing, review, scheduled, running, stopped, failed
• startAtone of 2 variants
  Show 2 variants

  • string
• campaignIdone of 2 variants
  Show 2 variants

  • number
• listIdone of 2 variants
  Show 2 variants

  • number
• sequenceone of 2 variants
  Show 2 variants

  • object[]
    Show array — 4 properties

    • daynumber
    • kindstring
      Allowed values: invite, linkedin, email
    • subjectstring
    • textstring
• buildone of 2 variants
  Show 2 variants

  • object
    Show 3 properties

    • labelstring
    • stepnumber
    • ofnumber
• strategystring
• reachesstring
• choicesstring[]
• audiencenumber

  Estimated leads who match

• creditsPerLeadnumber
• stepsobject[]
  Show array — 7 properties

  • idstring
  • kindstring
    Allowed values: reaction, invite, linkedin, email, comment, manual

    comment and manual are refused for now

  • delayobject
    Show 2 properties

    • countnumber
    • unitstring
      Allowed values: minutes, hours, days
  • afterstring
    Allowed values: previous, accept, no_reply
  • textstringoptional

    Variables look like {{first_name}}; a line of — splits a message

  • subjectstringoptional
  • reactionstringoptional
    Allowed values: match, like, celebrate, support, love, insightful, funny
• sampleobject[]
  Show array — 12 properties

  • leadIdnumber
  • namestring
  • titlestring
  • companystring
  • headlinestring
  • summarystring
  • imageUrlstring
  • linkedinUrlstring
  • locationstring
  • industrystring
  • fitone of 2 variants
    Show 2 variants

    • string
      Allowed values: good, bad
  • messagesobject[]
    Show array — 4 properties

    • daynumber
    • kindstring
      Allowed values: invite, linkedin, email
    • subjectstring
    • textstring
• logobject[]
  Show array — 3 properties

  • rolestring
    Allowed values: user, agent
  • textstring
  • atstring
• workingstring
• launchedAtone of 2 variants
  Show 2 variants

  • string