Skip to content
Soljio Docs
Esc
↑↓navigate↵open⌘Jpreview

Apply a reviewed schedule preview

Requires the unexpired preview and approval token from the same organization and service token. Rejects changed schedule state. Atomically creates dates once. The approval token binds the preview; the integration must obtain operator approval. Strict JSON body; maximum 16,384 UTF-8 bytes. Unknown query parameters and request fields are rejected. Requires schedule.apply.

POST/commands/apply_offering_schedule
Authorization
AuthorizationBearer token (soljio_sk_<secret>) · headerrequired

Organization-scoped service token created by an owner/admin. Scope requirements are in x-required-scopes; these are service-token grants, not OAuth scopes. Revoked, expired, unknown and suspended-organization credentials all return 401.

Header parameters
Idempotency-Keystringrequired

Persist with the job and reuse for retries. Scoped to organization, token, command and API version. Different input with the same key returns 409. Supported automatic retry window: 24 hours.

min length 1 · max length 128 · matches ^[!-~]+$
Request body
requiredapplication/json
preview_idstringrequired

Opaque Soljio ID. Do not parse or synthesize.

min length 1 · max length 256
approval_tokenstringrequired
min length 1 · max length 256
Responses
200

Successful operation.

dataapply_offering_scheduleResultrequired
Show properties
offering_idstringrequired

Opaque Soljio ID. Do not parse or synthesize.

min length 1 · max length 256
organization_idstringrequired

Opaque Soljio ID. Do not parse or synthesize.

min length 1 · max length 256
session_idsstring[]required
request_idstring<uuid>required
idempotent_replaybooleanrequired
400

invalid_request

errorobjectrequired
Show properties
codestringrequired
Allowed:invalid_request
messagestringrequired
request_idstring<uuid>required
401

unauthorized

errorobjectrequired
Show properties
codestringrequired
Allowed:unauthorized
messagestringrequired
request_idstring<uuid>required
403

forbidden

errorobjectrequired
Show properties
codestringrequired
Allowed:forbidden
messagestringrequired
request_idstring<uuid>required
404

not_found

errorobjectrequired
Show properties
codestringrequired
Allowed:not_found
messagestringrequired
request_idstring<uuid>required
405

method_not_allowed

errorobjectrequired
Show properties
codestringrequired
Allowed:method_not_allowed
messagestringrequired
request_idstring<uuid>required
409

conflict, idempotency_conflict

errorobjectrequired
Show properties
codestringrequired
Allowed:conflictidempotency_conflict
messagestringrequired
request_idstring<uuid>required
413

payload_too_large

errorobjectrequired
Show properties
codestringrequired
Allowed:payload_too_large
messagestringrequired
request_idstring<uuid>required
415

unsupported_media_type

errorobjectrequired
Show properties
codestringrequired
Allowed:unsupported_media_type
messagestringrequired
request_idstring<uuid>required
429

rate_limited

errorobjectrequired
Show properties
codestringrequired
Allowed:rate_limited
messagestringrequired
request_idstring<uuid>required
500

internal_error

errorobjectrequired
Show properties
codestringrequired
Allowed:internal_error
messagestringrequired
request_idstring<uuid>required
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X POST 'https://api.soljio.com/v0/commands/apply_offering_schedule' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Idempotency-Key: string' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "preview_id": "string",
  "approval_token": "string"
}'
Response
{
  "data": {
    "offering_id": "string",
    "organization_id": "string",
    "session_ids": [
      "string"
    ]
  },
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846",
  "idempotent_replay": true
}

Was this page helpful?