Documentation (2024.2 Enterprise)

# Account Settings

Account Settings are user-specific preferences that contain settings for things like e-mail notification frequency.

- Attributes
- Operations
  - `GET /account/settings/notifications`
  - `PUT /account/settings/notifications`

## Attributes

### account_id

Specify a user in the GET or PUT request to get or set account settings for the specified user. Must be done as a company admin user.

- Type: query

- Required: false

Add ?account_id=<user> to the request url to get or set account settings for the specified user.

### email

Interval settings for project-specific e-mail notifications. Possible `interval` values are `instant`, `daily`, `weekly`, and `never`. A valid Project ID must be provided with `project`.

- Type: `array` of `object`
- Required: `true`

    [
      {
        "project": "luotsi",
        "interval": "instant"
      }
    ]

## Operations

### GET /account/settings/notifications

Returns all notification settings for the current API user.

#### Example request

    curl -X GET \
      -H "Accept: application/vnd.hth.v1" \
      -H "Authorization: hth.company_key='$COMPANY_KEY',account_key='$ACCOUNT_KEY'" \
      https://helixteamhub.cloud/api/account/settings/notifications

#### Example response

    {
      "api_status": 200,
      "api_timestamp": "2014-10-06T14:59:05Z",
      "email":[
        {
          "project":{
            "id":"devrel",
            "uuid":"4a01b94a-bddf-426a-af00-7783a1639262"
          },
          "interval":"weekly"
        }
      ]
    }

### PUT /account/settings/notifications

Updates User Settings with the provided values.

#### Example request

    curl -X PUT \
      -H "Authorization: hth.company_key='$COMPANY_KEY',account_key='$ACCOUNT_KEY'" \
      -H "Content-Type: application/json" \
      -d '{ "email": [{ "project": "luotsi", "interval": "instant" }] }' \
      https://helixteamhub.cloud/api/account/settings/notifications

#### Example response

    {
      "api_status": 200,
      "api_timestamp": "2014-10-06T14:59:05Z",
      "email": [
        {
            "project": {
                "id": "luotsi",
                "uuid":"34ef5580-ebe6-4a82-be4a-a9d0ff36cd51"
            },
            "interval": "instant"
        },
        {
            "project": {
                "id:" "devrel",
                "uuid":"4a01b94a-bddf-426a-af00-7783a1639262"
            },
            "interval": "weekly"
        }
      ]
    }

Your search for returned results

Your search for returned results