Accounts

Update account info

Modify the details of an existing account.

The Update Account Info endpoint lets you modify details of an existing account, such as the account name, email, or preferences. Only the authenticated account owner (or an admin with elevated privileges) can update account information.

Endpoint

PATCH /v1/account

Headers

Key	Value	Required
Content-Type	application/json	Yes
Authorization	Bearer <access_token>	Yes

Request Body

You can update one or multiple fields. Fields not included in the request remain unchanged.

{
  "name": "Acme Corp.",
  "email": "new_email@example.com",
  "settings": {
    "currency": "EUR",
    "timezone": "Europe/Berlin",
    "language": "de"
  }
}

Field	Type	Required	Description
name	string	No	New account name.
email	string	No	New account email. Must be unique.
settings	object	No	Updated preferences (currency, timezone, language).

Response

Successful Response (200 OK)

{
  "id": "acct_001",
  "email": "new_email@example.com",
  "name": "Acme Corp.",
  "type": "business",
  "status": "active",
  "created_at": "2025-01-12T09:30:00Z",
  "updated_at": "2025-09-18T20:12:00Z",
  "settings": {
    "currency": "EUR",
    "timezone": "Europe/Berlin",
    "language": "de"
  }
}

Field	Type	Description
id	string	Unique identifier of the account.
email	string	Updated account email.
name	string	Updated account name.
type	string	individual or business.
status	string	Current status of the account.
created_at	string	ISO 8601 timestamp when the account was created.
updated_at	string	ISO 8601 timestamp when the account was last updated.
settings	object	Updated preferences.

Error Response (400 / 409)

{
  "error": "email_exists",
  "message": "This email is already linked to another account."
}

Error Code	Meaning
invalid_request	The request body contains invalid or missing fields.
email_exists	Attempted to update to an email already in use.
unauthorized	The provided token does not have permission to update this account.

Example Usage

cURL

curl -X PATCH "https://api.example.com/v1/account" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your_access_token" \
  -d '{
    "name": "Acme Corp.",
    "email": "new_email@example.com",
    "settings": {
      "currency": "EUR",
      "timezone": "Europe/Berlin",
      "language": "de"
    }
  }'

JavaScript (Fetch)

const response = await fetch("https://api.example.com/v1/account", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer your_access_token"
  },
  body: JSON.stringify({
    name: "Acme Corp.",
    email: "new_email@example.com",
    settings: {
      currency: "EUR",
      timezone: "Europe/Berlin",
      language: "de"
    }
  })
});

const data = await response.json();
console.log(data.updated_at);

Updating sensitive fields such as email may trigger a verification flow depending on your account policies.

Create an account

Close an account

Need help? Contact Support

Join our Discord Community

Questions? Contact Sales

On this page

Title