Skip to main content
POST
Activate an API account

Authorizations

Authorization
string
header
required

Verified Batch Relay dashboard session token. This is distinct from a scoped Batch Relay API key.

Headers

Idempotency-Key
string
required
Required string length: 1 - 200
X-BatchRelay-Client-Surface
string

Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Client-Version
string

Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Invocation-Mode
string

Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100

Path Parameters

account_id
string
required
Required string length: 1 - 256

Response

API account

billing
object
required
id
string
required
owner
object
required

Exactly one reference is present: studio_id for studio accounts or individual_owner_user_id for individual accounts.

status
enum<string>
required
Available options:
active,
disabled
created_by_user_id
string