Skip to main content
POST
/
v2
/
client-ids
Create a new client ID
curl --request POST \
  --url https://api.stage.request.network/v2/client-ids \
  --header 'Content-Type: application/json' \
  --data '{
  "label": "My Client ID",
  "allowedDomains": [
    "https://example.com"
  ]
}'
{
  "id": "<string>",
  "clientId": "<string>",
  "label": "<string>",
  "allowedDomains": [
    "<string>"
  ],
  "feePercentage": "<string>",
  "feeAddress": "<string>",
  "status": "<string>",
  "createdAt": "<string>"
}

Headers

​
x-api-key
string

API key for authentication (optional if using session)

​
Authorization
string

Bearer token for session authentication (optional if using API key)

Example:

"Bearer <session-token>"

Body

application/json
​
label
string
required
Required string length: 1 - 100
​
allowedDomains
string<uri>[]
required

List of allowed domain origins (normalized)

Required array length: 1 - 10 elements
​
feePercentage
string

Fee percentage (e.g., '1' = 1%, '2.5' = 2.5%). If set to '0', allows API request fees to take precedence. If set to any other value, overrides any fee passed via API.

Minimum length: 1
​
feeAddress
string

Wallet address to receive fees. Required if feePercentage is set.

Response

Client ID created successfully

​
id
string
​
clientId
string
​
label
string
​
allowedDomains
string[]
​
feePercentage
string | null
​
feeAddress
string | null
​
status
string
​
createdAt
string