Manage Request

curl --request POST \
  --url https://brokers.newyorkcityservers.com/api/v1/requests/{request_id}/manage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "approve"
}
'

{
  "success": true,
  "data": {
    "request_id": "REQ-002167",
    "request_status": "approved",
    "service_number": 30502
  }
}

POST

requests

{request_id}

manage

curl --request POST \
  --url https://brokers.newyorkcityservers.com/api/v1/requests/{request_id}/manage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "approve"
}
'

{
  "success": true,
  "data": {
    "request_id": "REQ-002167",
    "request_status": "approved",
    "service_number": 30502
  }
}

Approve or deny one pending request in your broker account. Use the public request ID from the list requests endpoint.

Request type	Approval operation	HTTP `200` request status
`new-service`	Creates or reuses a pending service and queues a service creation action. The worker provisions the service and runs enabled invoice, welcome-email, follow-up, and setup-notification operations.	`approved`
`cancellation`	Queues a cancellation action. The worker processes the upstream cancellation and local service changes.	`accepted`
`upgrade` or `downgrade`	Queues a plan-change action. The worker processes the upstream plan change and local service changes.	`approved`
`welcome-email`	Tries the welcome-email resend during the approval call.	`approved`
Other pending request types	Records the request approval.	`approved`

Errors

All error responses use success: false and an error object.

HTTP status	Error code	Cause
`400`	`invalid_parameter`	The request ID format or action is invalid.
`400`	`invalid_request`	The request body is not valid JSON.
`400`	`missing_parameter`	A denial has no nonblank `denial_reason`.
`401`	`authentication_failed`	The Bearer token is missing, invalid, inactive, or expired.
`403`	`insufficient_permissions`	The caller IP is not allowed, or the key does not have `requests:write` or `admin:full`.
`404`	`not_found`	The request does not exist in this broker account.
`409`	`already_processed`	The request is not `pending`, or another caller processed it first.
`429`	`rate_limit_exceeded`	The API key reached its rate limit. Check the `Retry-After` header.
`500`	`server_error`	The denial update or another internal operation failed.

An already_processed response can include the request’s current stored state.

Authorizations

Authorization

string

header

required

Send the API key in the Authorization bearer header. Production keys begin with sk_live_.

Path Parameters

request_id

string

required

Public request ID in REQ- followed by digits format; matching is case-insensitive.

Pattern: ^[Rr][Ee][Qq]-[0-9]+$

Example:

"REQ-002167"

Body

application/json

action

enum<string>

required

Accepted case-insensitively after trimming.

Available options:

approve,

deny

denial_reason

string

Required and nonblank when action is deny.

Minimum string length: 1

Response

Request approved, accepted, or denied.

success

boolean

required

data

object

required

Show child attributes

message

string

pagination

object

Show child attributes

Last modified on August 2, 2026

List Requests

Services Report

Getting Started

Services

Requests

Reports

Errors

Authorizations

Path Parameters

Body

Response

​Errors

Authorizations

Path Parameters

Body

Response

Errors