Add a writing rule to the style doc, then rewrite the first sequence

POST/v1/autopilot/rules

POSTRequest

curl -X POST "https://prestigious-goldfish-661.convex.site/v1/autopilot/rules" \
    -H "Authorization: Bearer $REACHIZ_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"rule":"<rule>"}'

Responses

Response 200

Success

application/json

Example responseGenerated from schema

{
  "status": "setup",
  "step": -9007199254740991,
  "website": "website",
  "profile": {
    "business": "business",
    "summary": "summary"
  },
  "profileState": "reading",
  "customerTypes": [
    {
      "id": "id",
      "title": "title",
      "detail": "detail"
    }
  ],
  "customerTypeId": "customerTypeId",
  "targets": {
    "summary": "summary",
    "rows": [
      {
        "key": "titles",
        "chips": [
          {}
        ]
      }
    ],
    "evenBetter": [
      "evenBetter"
    ]
  },
  "channel": "linkedin_email",
  "country": "country",
  "offer": {
    "kind": "call",
    "text": "text"
  },
  "alerts": {
    "kind": "email",
    "target": "target",
    "replies": true
  },
  "rules": [
    "rules"
  ],
  "error": "error",
  "progress": {
    "phase": "profile",
    "pct": 0,
    "done": [
      "done"
    ],
    "active": "active"
  },
  "plays": [
    {
      "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
      }
    }
  ],
  "senders": {
    "linkedin": -9007199254740991,
    "email": -9007199254740991
  },
  "neverContact": -9007199254740991,
  "startedAt": "startedAt",
  "pausedAt": "pausedAt"
}

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 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"
      }
    ]
  }
}

Request body

Required: Yes
Content type: application/json

rulestringrequired

Returns

Schema shown for 200 · application/json

statusstring
Allowed values: setup, active, paused
stepnumber
websitestring
profileone of 2 variants
Show 2 variants
- object
  Show 2 properties
  - businessstring
  - summarystring
profileStateone of 2 variants
Show 2 variants
- string
  Allowed values: reading, understanding, writing, done, failed
customerTypesobject[]
Show array — 3 properties
- idstring
- titlestring
- detailstring
customerTypeIdstring
targetsone of 2 variants
Show 2 variants
- object
  Show 3 properties
  - summarystring
  - rowsobject[]
    Show array — 2 properties
    keystring
    Allowed values: titles, companyType, size, location
    chipsobject[]
  - evenBetterstring[]
channelone of 2 variants
Show 2 variants
- string
  Allowed values: linkedin_email, linkedin
countrystring
offerone of 2 variants
Show 2 variants
- object
  Show 2 properties
  - kindstring
    Allowed values: call, other
  - textstring
alertsone of 2 variants
Show 2 variants
- object
  Show 3 properties
  - kindstring
    Allowed values: email, slack, sms
  - targetstring
    A Slack webhook is masked
  - repliesboolean
rulesstring[]
errorstring
The last failed step, in plain words; null once a step starts again
progressone of 2 variants
Show 2 variants
- object
  Show 4 properties
  - phasestring
    Allowed values: profile, targets, plays, sequence, build
  - pctnumber
  - donestring[]
  - activestring
playsobject[]
Show array — 14 properties
- 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
sendersobject
Show 2 properties
- linkedinnumber
- emailnumber
neverContactnumber
startedAtone of 2 variants
Show 2 variants
- string
pausedAtone of 2 variants
Show 2 variants
- string