Skip a waiting message or email: the person moves on to the next step

POSTRequest

curl -X POST "https://prestigious-goldfish-661.convex.site/v1/approvals/$ID/skip" \
    -H "Authorization: Bearer $REACHIZ_API_KEY"

Responses

200400401403404409429503

Response 200

Success

application/json

Example responseGenerated from schema

{
  "id": -9007199254740991,
  "campaignId": -9007199254740991,
  "campaignName": "campaignName",
  "kind": "message",
  "status": "pending",
  "text": "text",
  "subject": "subject",
  "edited": true,
  "lead": {
    "id": -9007199254740991,
    "name": "name",
    "title": "title",
    "company": "company",
    "imageUrl": "imageUrl"
  },
  "sender": "sender",
  "createdAt": "createdAt"
}

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

Returns

Schema shown for 200 · application/json

• idnumber
• campaignIdnumber
• campaignNamestring
• kindstring
  Allowed values: message, inmail, email
• statusstring
  Allowed values: pending, approved, skipped, done
• textstring
• subjectstring
• editedboolean
• leadone of 2 variants
  Show 2 variants

  • object
    Show 5 properties

    • idnumber
    • namestring
    • titlestring
    • companystring
    • imageUrlstring
• senderstring
• createdAtstring