Skip to main content
PATCH
/
v1
/
accounts
/
{account_id}
/
earn
/
auto
curl --request PATCH \
  --url https://api.services.payward.com/v1/accounts/{account_id}/earn/auto \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --header 'api-nonce: <api-key>' \
  --header 'api-otp: <api-key>' \
  --header 'api-sign: <api-key>' \
  --data '
{
  "staking": "enabled"
}
'
{}

Authorizations

api-key
string
header
required
api-sign
string
header
required
api-nonce
string
header
required
api-otp
string
header
required

Path Parameters

account_id
string
required

ID of the account to update preferences for. Refers to one of the accounts held by the user the request is acting on behalf of.

Required string length: 5 - 34
Pattern: ^[A-Z]{2}[0-9]{2}[A-Z0-9]+$

Body

application/json

Request to set auto-earn preferences for an account.

staking
enum<string>

Staking auto-earn preference. Omit to leave unchanged.

Available options:
enabled,
disabled

Response

Successful response

Response from SetAutoEarnPreferences (empty on success).