PUT/people/{id}.json

Editing a User

Edit a user's details using this endpoint.

Use this endpoint to:

  • Change a user type: passing in the account type will change the user account. There is 3 types of accounts: Contact, Collaborator, Account.
{
    "person": {
        "user-type": "contact",
        "removeFromProjects": "1"
    }
}
  • Update to an admin: Changing a person from a standard user to an adminstrator.
{
 "person": {
   "administrator": "true"
 }
}
  • Unassign a user from all tasks: This will remove the user from any Tasks they have been assigned to.
{
    "person": {
        "unassignFromAll": "1"
    }
}

Path Params

  • Name
    id
    Type
    string
    required
    Description
    Id of the person.

Body Params

    • Name
      person
      Type
      object

    Responses

    • Code
      200
      Type
      object
      Schema
      Description
      200 Response

    Examples

    200 Response

    application/json
    {
      "id": 1234,
      "STATUS": "OK"
    }