Public Transfer Token

Sets a token's public transfer status, controlling whether it can be transferred outside the platform.

Request

POST /v2/admin/token/{token_id}/public-transfer

Parameters

Name	Type	In	Description
token_id	string	path	Required. The ID of the token to update

Headers

Name	Description
Authorization	Required. Bearer token for authentication
Content-Type	Required. Must be application/json

Request Body

Name	Type	Description
is_public	boolean	Required. Set to true to allow external transfers, false to restrict transfers to the platform

Example

curl --request POST \
  --url '\{\{baseUrl\}\}/v2/admin/token/67d8774e903bfcbe7eb5d93e/public-transfer' \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
  --header 'Content-Type: application/json' \
  --header 'User-Agent: insomnia/10.3.1' \
  --data '{
	"is_public": true
}'

Response

A successful response returns an empty object:

{}

Status Codes

Status Code	Description
200	Success - Token's public transfer status has been updated 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