Skip to main content
POST
/
0
/
private
/
UpdatePrimeApiUser
Update Prime API User
curl --request POST \
  --url https://api.kraken.com/0/private/UpdatePrimeApiUser \
  --header 'API-Key: <api-key>' \
  --header 'API-Sign: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nonce": 123,
  "user_id": "2T0RXL9B8K5D6",
  "name": "Updated User Name",
  "status": "Enabled"
}
'
{
  "result": {
    "id": "2T0RXL9B8K5D6",
    "name": "Test User",
    "status": "Enabled",
    "roles": [
      "Trader"
    ]
  },
  "error": [
    "EGeneral:Invalid arguments"
  ]
}

Authorizations

​
API-Key
string
header
required

The "API-Key" header should contain your API key.

​
API-Sign
string
header
required

Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path.

Body

application/json
​
nonce
integer<int64>
required

Nonce used in construction of API-Sign header

​
user_id
string
required

The unique identifier of the API user to update.

Example:

"2T0RXL9B8K5D6"

​
name
string

New display name for the API user.

Example:

"Updated User Name"

​
status
enum<string>

New status for the API user.

Available options:
Enabled,
Disabled
Example:

"Enabled"

Response

API user updated.

Response containing the updated Prime API user.

​
result
object
required

Prime API user information.

​
error
string[]
required

Kraken API error