v1Resources/Approvals/postDecline an item
Decline an item
Declines a pending item so it does not run, with an optional reason. Answers 409 when it was already decided.
post
approvals:write/api/v1/approvals/{id}/declineQuery parameters
idstringrequired
Request body
reasonstringoptional
Why you approved or declined it, up to 2,000 characters. It is kept with the decision.
Response
dataobjectoptional
idstringoptional
statusstring (pending | approved | rejected)optional
kindstringoptional
What kind of item this is, for example content your agent drafted or an action held by your autonomy rules.
originstringoptional
titlestringoptional
summarystringoptional
clientIdstringoptional
modulestringoptional
changeobjectoptional
The exact action that runs on approval: the tool, its arguments and the fields it changes.
toolstringoptional
argsobjectoptional
fieldsarray of objectoptional
contentobjectoptional
The drafted content, when the item is content.
requestedAtstringoptional
scheduledForstringoptional
expiresAtstringoptional
decidedAtstringoptional
decidedBystringoptional
Who made the decision, or null while it is still pending.
decisionReasonstringoptional
publishStatestring (published | failed)optional
publishErrorstringoptional
publishedAtstringoptional
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409The request conflicts with the current state of the resource — for example, changing the email or phone of a recipient who has already been messaged, or a team invite that was already accepted (or hasn't been accepted yet).
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/approvals/{id}/decline
Your API key
id *
Request body
{}