Skip to main content
POST
Settle an attempt

Authorizations

Authorization
string
header
required

nia_sk_...

Headers

Idempotency-Key
string
required
Required string length: 1 - 256

Path Parameters

effect_id
string
required

Body

application/json
attempt
integer
required
Required range: x >= 1
state
enum<string>
required
Available options:
done,
failed,
unknown_outcome

Response

The effect as it stands after the settlement.

effect_id is the key's keyed hash: it names the effect in paths, where the key itself, which may carry a conversation id, never goes.

attempt
integer
required
effect_id
string
required
Pattern: ^[A-Za-z0-9_-]{43}$
reserved_at
string<date-time>
required
state
enum<string>
required
Available options:
reserved,
done,
failed,
unknown_outcome
done_at
string<date-time> | null