Skip to content
UltimateTeam.ai Docs

Approve with modifications

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

Approves a pending action but requests modifications before execution.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
approval_id
required
Approval Id

The approval item ID to modify

string

The approval item ID to modify

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ModifyRequest

Request body for approving an action with modifications.

Attributes: modifications: What should be changed before execution. feedback: Why the modifications are needed.

object
approval_token
required
Approval Token
string
>= 64 characters <= 64 characters
feedback
required
Feedback
string
modifications
required
Modifications
string
Examplegenerated
{
  "approval_token": "example",
  "feedback": "example",
  "modifications": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

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"
  }
}

422

Section titled “422”

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"
    }
  ]
}