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

Use a makeup credit only when a confirmed destination seat can be created in the same write.

Use a makeup credit only when a confirmed destination seat can be created in the same write. Requires makeups.write. All writes require Idempotency-Key; x-scope-rules declares additional grants by input condition.

POST/commands/consume_makeup_credit
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
makeup_credit_idstringrequired

Opaque Soljio resource ID.

min length 1
target_session_idstringrequired

Opaque Soljio resource ID.

min length 1
Responses
200

Successful command; replay returns the original result.

dataobjectrequired
Show properties
enrollment_idstringrequired

Opaque Soljio resource ID.

min length 1
okbooleanrequired
participant_namestringrequired
remaining_available_creditsnumberrequired
reservation_statusstringrequired
target_ends_atstring<date-time>required
target_offering_namestringrequired
target_session_idstringrequired

Opaque Soljio resource ID.

min length 1
target_starts_atstring<date-time>required
target_timezonestring
idempotent_replaybooleanrequired
request_idstring<uuid>required
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/consume_makeup_credit' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Idempotency-Key: string' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "makeup_credit_id": "string",
  "target_session_id": "string"
}'
Response
{
  "data": {
    "enrollment_id": "string",
    "ok": true,
    "participant_name": "string",
    "remaining_available_credits": 0,
    "reservation_status": "confirmed",
    "target_ends_at": "2019-08-24T14:15:22Z",
    "target_offering_name": "string",
    "target_session_id": "string",
    "target_starts_at": "2019-08-24T14:15:22Z",
    "target_timezone": "string"
  },
  "idempotent_replay": true,
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"
}