Passive Token
Puts a specific token into the passive (read-only) state. This call is asynchronous — the handler enqueues a PassiveToken blockchain transaction and returns HTTP 200 immediately. The token only becomes passive on-chain once the wallet pipeline confirms the transaction. Poll List Token Transactions to observe completion.
Request
POST /v2/admin/tokens/{token_id}/passive
Parameters
| Name | Type | In | Description |
|---|---|---|---|
token_id | string | path | Required. The ID of the token to make passive |
Headers
| Name | Description |
|---|---|
Authorization | Required. Bearer token for authentication |
Content-Type | Required. Must be application/json |
Example
curl --request POST \
--url '\{\{baseUrl\}\}/v2/admin/tokens/67d8774e903bfcbe7eb5d93e/passive' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
--header 'Content-Type: application/json' \
--header 'User-Agent: insomnia/10.3.1' \
--data '{}'
Response
A successful response returns an empty object:
{}
Status Codes
| Status Code | Description |
|---|---|
| 200 | Success - Token has been made passive successfully |
| 400 | Bad Request - Invalid request parameters |
| 401 | Unauthorized - Invalid or missing authentication token |
| 404 | Not Found - Token ID does not exist |
| 500 | Internal Server Error |