Skip to main content
POST
Encerrar uma tentativa

Autorizações

Authorization
string
header
obrigatório

nia_sk_...

Cabeçalhos

Idempotency-Key
string
obrigatório

Fica guardada 24 horas com o hash do corpo; a mesma chave com outro corpo devolve 409.

Required string length: 1 - 256

Parâmetros de caminho

effect_id
string
obrigatório

Corpo

application/json
attempt
integer
obrigatório
Intervalo obrigatório: x >= 1
state
enum<string>
obrigatório
Opções disponíveis:
done,
failed,
unknown_outcome

Resposta

O efeito como fica depois do encerramento.

effect_id é o hash com chave da chave do efeito: nomeia o efeito nos caminhos, onde a própria chave, que pode levar um id de conversa, nunca vai.

attempt
integer
obrigatório
effect_id
string
obrigatório
Pattern: ^[A-Za-z0-9_-]{43}$
reserved_at
string<date-time>
obrigatório
state
enum<string>
obrigatório
Opções disponíveis:
reserved,
done,
failed,
unknown_outcome
done_at
string<date-time> | null