SHshiprush
Users

Update a user

put/users/{id}

Request

  • Base URL
    https://company.aha.io/api/v1
  • Auth
    • OAuth 2
      Authorization codehttps://{account-domain}.aha.io/oauth/authorize
      Token URLhttps://{account-domain}.aha.io/oauth/token
    • or HTTP bearer
    • or API key in cookie session
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Id identifier

Request body

Example request

{
  "user": {
    "first_name": "Sarah",
    "enabled": false
  }
}

Response

Successful operation

idstring
namestring
emailstring
timezonestring
created_atstring
updated_atstring
accessed_atstring
enabledboolean
paid_seatboolean
administratorboolean

Example response

{
  "id": "1020675218",
  "name": "Sarah Humpty",
  "email": "no-reply@aha.io",
  "timezone": "America/Los_Angeles",
  "created_at": "2019-01-01T00:00:00.000Z",
  "updated_at": "2019-01-01T00:00:00.000Z",
  "accessed_at": "2019-01-01T00:00:00.000Z",
  "product_roles": [
    {
      "role": 20,
      "role_description": "Owner",
      "product_id": "131414752",
      "product_name": "Project 1"
    },
    {
      "role": 20,
      "role_description": "Owner",
      "product_id": "517761884",
      "product_name": null
    },
    {
      "role": 20,
      "role_description": "Owner",
      "product_id": "610602692",
      "product_name": null
    }
  ],
  "enabled": false,
  "paid_seat": true,
  "administrator": false,
  "administrator_roles": {
    "administer_account": false,
    "administer_billing": false,
    "administer_configuration": false
  },
  "identity_provider": {
    "type": "password"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.