Skip to main content
POST
Reserve an effect

Authorizations

Authorization
string
header
required

nia_sk_...

Headers

Idempotency-Key
string
required

Required. Kept 24 hours with the hash of the body: a retry with the same key returns the first answer, and the same key with a different body returns 409 conflict.

Required string length: 1 - 256

Body

application/json
effect_key
string
required
Required string length: 1 - 512
kind
enum<string>
required
Available options:
delivery,
document,
notice,
filing,
paid_call,
external_action
cost_units
integer
default:0
Required range: x >= 0
fact
ObjectRef · object | null

A business object in a system of record, e.g. invoice / erp / 0823.

Response

The key was done or ambiguous already: nothing was reserved, do not act.