user_groups

Update an existing user group.

Used to update a single user group. The available fields are still limited.

put/v1/user-groups/{id}

Path parameters

idstring required
Example:1

The ID of the account.

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Request body

titlestring string required

A descriptive title for the user group.

primary_currency_idstring string

Use either primary_currency_id or primary_currency_code. This will set the primary currency for the user group ('financial administration').

primary_currency_codestring string

Use either primary_currency_id or primary_currency_code. This will set the primary currency for the user group ('financial administration').

Example request

{
  "title": "New user group title",
  "primary_currency_id": "1",
  "primary_currency_code": "EUR"
}

Response

Updated user group is stored, result is in the response

Changes