Post report-schedules

POST

https://api.cloudraker.com/v1/signing/report-schedules

POST

/v1/signing/report-schedules

curl -X POST https://api.cloudraker.com/v1/signing/report-schedules \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "cadence": "daily",
  "time": "string",
  "timeZone": "string",
  "recipientIds": [
    "string"
  ],
  "name": "string",
  "idempotencyKey": "string"
}'

{
  "schedule": {
    "id": "string",
    "kind": "report",
    "name": "string",
    "ownerId": "string",
    "payload": {},
    "status": "scheduled",
    "registration": "pending",
    "version": 1,
    "nextRunAt": 1.1,
    "createdAt": "string",
    "updatedAt": "string",
    "history": [
      {
        "at": "string",
        "status": "completed",
        "result": {},
        "error": "string"
      }
    ],
    "integrationId": "string",
    "teamId": "string",
    "lastRunAt": "string",
    "result": {},
    "error": "string"
  }
}

Uses the same resource permissions and lifecycle as the RakeSign application. Integration access is limited to its shared team. Required scopes: reports:write, documents:read.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

cadenceenumRequired

Allowed values:

timestringRequiredformat: "^(?:[01]\d|2[0-3]):[0-5]\d$"

timeZonestringRequired1-100 characters

recipientIdslist of stringsRequired

namestringRequired1-100 characters

idempotencyKeystringRequired8-128 characters

weekdayintegerOptional0-6

filtersobjectOptionalDefaults to {}

Response

Authorized signing resource.

scheduleobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error

503

Service Unavailable Error