Redeem a workspace code

POST

/workspace-codes/redeem

WorkspaceCodes

Redeem a workspace code for the current authenticated user. The code is submitted in the request body to avoid leaking it into access logs.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Workspace code redeemed successfully

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.aworld.cloud/app/v1/workspace-codes/redeem' \
--header 'x-external-user-id;' \
--header 'x-user-id;' \
--header 'Content-Type: application/json' \
--data '{
    "code": "string"
}'

Response Example

{
    "redeemed": true,
    "workspaceCodeId": "string",
    "role": "owner",
    "metadata": {
        "property1": "string",
        "property2": "string"
    }
}

Modified at 2026-06-15 16:41:07

Search virtual transactions history

Get workspace configuration