Helix TeamHub Developer Guide (2020.1 Enterprise)

Account Settings

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

Attributes

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": "luotsi",
      "interval": "daily"
    },
    {
      "project": "devrel",
      "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": "luotsi",
      "interval": "instant"
    },
    {
      "project": "devrel",
      "interval": "weekly"
    }
  ]
}