PUT /v1/accounts/:id
{
  "id": "c64ce66b70b21c03bfd5dfa0ab14b730",
  "name": "Ted Annature",
  "email": "ted@annature.com.au",
  "number": "1300 000 000",
  "timezone": "+10:00",
  "role": "administrator",
  "active": true,
  "organisation_id": "62e9a87c6ed1444d9d228c4a0374017d",
  "group_id": "a5a885caee6286a54ad7bbd4ab5400e9",
  "created": "2019-12-17T05:30:00Z",
  "verified": "2019-12-17T05:30:00Z"
}

Updates the details of an existing account in your organisation.

You can use this endpoint to change an account’s name, email address, contact number, timezone, role, or group assignment.

Parameters

id
string
required

The unique identifier for the account.

name
string

The account holder’s full name.

email
string

The account holder’s email address. This will be used to log in to the Annature dashboard.

If the email is updated, a confirmation email is sent to the new address. The change will not take effect until the user clicks the confirmation link.

Email addresses must be unique. You cannot update an account to use an email that already exists.

Currently, there is no way to check whether an email change is pending via the API.

number
string

The account holder’s contact number.

timezone
string

The timezone for this account, supplied as a 6-digit UTC offset.

Timezones must be supplied as a 6-digit UTC offset. For example:

  • +10:00 → Australia/Brisbane
  • +08:00 → Australia/Perth
role
string

The account role.

Valid values: administrator, standard, read-only.

group_id
string

The unique identifier of the group this account should be assigned to.

PUT /v1/accounts/:id
{
  "id": "c64ce66b70b21c03bfd5dfa0ab14b730",
  "name": "Ted Annature",
  "email": "ted@annature.com.au",
  "number": "1300 000 000",
  "timezone": "+10:00",
  "role": "administrator",
  "active": true,
  "organisation_id": "62e9a87c6ed1444d9d228c4a0374017d",
  "group_id": "a5a885caee6286a54ad7bbd4ab5400e9",
  "created": "2019-12-17T05:30:00Z",
  "verified": "2019-12-17T05:30:00Z"
}