Register approval vote

POST

/v1/cards/{cardId}/phases/{phaseId}/actions/approval

Registers a new approval vote for a card, in the indicated phase. The call is used by the current approver within the chain configured for the phase — the phase must already have at least one approval rule registered; otherwise, the call returns an error for not finding an applicable rule for the card.

All three fields in the payload are required: status (approved, rejected or approved_with_reservations), value (a number greater than or equal to zero) and comment (a non-empty text). Unlike other decision modules on a card, the comment is always required here, even for a straightforward approval.

When status is rejected, value must be exactly zero — approval values (value greater than zero) only apply when status is approved, representing the approved limit or amount.

The same approver cannot vote twice in the same chain: a second voting attempt returns an error stating that the vote has already been completed. If a previous call returned an unexpected error, we recommend checking the card's approval record before retrying — the vote may already have been persisted despite the reported error.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201Vote registered

application/json

Illustrative example of the response.

Bodyapplication/json

🟠404Rule not found

🟠400Invalid payload

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/cards//phases//actions/approval' \
--header 'Content-Type: application/json' \
--data '{
    "status": "approved",
    "value": 0,
    "comment": "string"
}'

Response Example

201 - Exemplo 1

{
    "id": "string",
    "status": "string",
    "value": 0,
    "comment": "string"
}

Modificado em 2026-07-29 12:58:18