Create a draft campaign

POSTRequest

curl -X POST "https://prestigious-goldfish-661.convex.site/v1/campaigns" \
    -H "Authorization: Bearer $REACHIZ_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"name":"<name>","listId":0,"accountIds":[0],"sequence":[{"type":"connection_request"}]}'

Responses

201400401403409429503

Response 201

Success

application/json

Example responseGenerated from schema

{
  "id": 0,
  "name": "name",
  "status": "draft",
  "listId": 0,
  "accountIds": [
    0
  ],
  "sequence": [
    {
      "type": "type",
      "delay": {
        "value": -9007199254740991,
        "unit": "hours"
      },
      "message": "message",
      "subject": "subject"
    }
  ],
  "schedule": {
    "timezone": "timezone",
    "days": [
      0
    ],
    "startTime": "startTime",
    "endTime": "endTime",
    "startDate": "startDate",
    "endDate": "endDate"
  },
  "stats": {
    "leads": -9007199254740991,
    "pending": -9007199254740991,
    "active": -9007199254740991,
    "paused": -9007199254740991,
    "finished": -9007199254740991,
    "failed": -9007199254740991,
    "stopped": -9007199254740991,
    "excluded": -9007199254740991,
    "invitesSent": -9007199254740991,
    "accepted": -9007199254740991,
    "messagesSent": -9007199254740991,
    "replies": -9007199254740991
  },
  "createdAt": "createdAt",
  "startedAt": "startedAt"
}

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

• namestringrequired
• listIdnumberrequired
• accountIdsnumber[]required
• sequenceobject[]required
  Show array — 4 properties

  • typestringrequired
    Allowed values: connection_request, message, inmail, view_profile, follow, like_post
  • delayobjectoptional

    Wait before this step runs.

    Show 2 properties

    • valuenumberrequired
    • unitstringrequired
      Allowed values: hours, days
  • messagestringoptional

    Connection note, message text or InMail body.

  • subjectstringoptional

    InMail subject.

• scheduleobjectoptional
  Show 4 properties

  • timezonestringoptional
  • daysnumber[]optional
  • startTimestringoptional
  • endTimestringoptional

Returns

Schema shown for 201 · application/json

• idnumber
• namestring
• statusstring
  Allowed values: draft, scheduled, starting, running, paused, finished, canceled, failed, locked
• listIdone of 2 variants
  Show 2 variants

  • number
• accountIdsnumber[]
• sequenceobject[]
  Show array — 4 properties

  • typestring
  • delayobjectoptional
    Show 2 properties

    • valuenumber
    • unitstring
      Allowed values: hours, days
  • messagestringoptional
  • subjectstringoptional
• scheduleobject
  Show 6 properties

  • timezonestring
  • daysnumber[]
  • startTimestring
  • endTimestring
  • startDateone of 2 variants
    Show 2 variants

    • string
  • endDateone of 2 variants
    Show 2 variants

    • string
• statsobject
  Show 12 properties

  • leadsnumber
  • pendingnumber
  • activenumber
  • pausednumber
  • finishednumber
  • failednumber
  • stoppednumber
  • excludednumber
  • invitesSentnumber
  • acceptednumber
  • messagesSentnumber
  • repliesnumber
• createdAtstring
• startedAtone of 2 variants
  Show 2 variants

  • string