Skip to content

Reject an action

POST
/api/v1/approvals/{approval_id}/reject
curl --request POST \
--url https://api.ultimateteam.ai/api/v1/approvals/example/reject \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <X-API-Key>' \
--data '{ "approval_token": "example", "reason": "example" }'

Rejects a pending action with a required reason.

approval_id
required
Approval Id

The approval item ID to reject

string

The approval item ID to reject

Media typeapplication/json
RejectRequest

Request body for rejecting an action.

Attributes: reason: Why the action was rejected (required).

object
approval_token
required
Approval Token
string
>= 64 characters <= 64 characters
reason
required
Reason
string
Examplegenerated
{
"approval_token": "example",
"reason": "example"
}

Successful Response

Media typeapplication/json
ApprovalResponse

Envelope response for approval action endpoints.

Attributes: data: The approval decision payload. meta: Standard response metadata.

object
data
required
ApprovalDecisionData

Inner data payload for approval decision responses.

Attributes: decision: The decision made (approved, rejected, modified). decision_id: The ID of the approval that was acted on. action_type: The action type that was decided on. feedback: Owner feedback, if provided. reason: Rejection reason, if applicable. modifications: Requested modifications, if applicable. execution_result: Result of executing the action, if available.

object
action_type
required
Action Type
string
decision
required
Decision
string
decision_id
required
Decision Id
string
execution_result
Any of:
object
key
additional properties
any
feedback
Any of:
string
modifications
Any of:
string
reason
Any of:
string
meta
ResponseMeta

Standard metadata included in every API response.

Attributes: request_id: Unique identifier for this request. timestamp: When the response was generated.

object
request_id
Request Id

Unique identifier for this request

string
timestamp
Timestamp

When the response was generated

string format: date-time
Examplegenerated
{
"data": {
"action_type": "example",
"decision": "example",
"decision_id": "example",
"execution_result": {},
"feedback": "example",
"modifications": "example",
"reason": "example"
},
"meta": {
"request_id": "example",
"timestamp": "2026-04-15T12:00:00Z"
}
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}