Get the settings of a campaign: approval, sender names, out of office, daily cap, priority, auto pause, skips

GETRequest

curl "https://prestigious-goldfish-661.convex.site/v1/campaigns/$ID/settings" \
    -H "Authorization: Bearer $REACHIZ_API_KEY"

Responses

200400401403404429503

Response 200

Success

application/json

Example responseGenerated from schema

{
  "approveBeforeSend": true,
  "fixSenderNames": true,
  "continueAfterOoo": true,
  "keepFinding": true,
  "dailyNewLeads": 1,
  "prioritize": true,
  "autoPause": true,
  "skips": {
    "inOtherCampaigns": true,
    "contactedBefore": true,
    "alreadyConnected": true
  },
  "autopilot": true,
  "emailAccountIds": [
    -9007199254740991
  ]
}

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 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

Returns

Schema shown for 200 · application/json

• approveBeforeSendboolean

  Messages and emails wait for approval; nothing sends until a person approves

• fixSenderNamesboolean

  A message that names another sender of the workspace gets the real sender’s name

• continueAfterOooboolean

  Out of office: resume the day after the return date (a week later without one); off stops the person

• keepFindingboolean

  Autopilot adds more people while the campaign runs low

• dailyNewLeadsone of 2 variants

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

  Show 2 variants

  • number
• prioritizeboolean

  This campaign’s actions go out before other campaigns’ actions

• autoPauseboolean

  An Autopilot campaign that does not work gets a heads-up, then pauses

• emailAccountIdsnumber[]optional
• skipsobject
  Show 3 properties

  • inOtherCampaignsboolean
  • contactedBeforeboolean
  • alreadyConnectedboolean
• autopilotboolean