Examples

$ curl -i \
  -H "Accept: application/json; version=1" \
  -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjQyLCJpYXQiOjE0NjM2OTQ4MjN9.k48v-R-un93KdIXqp9Zi12JOGJCu8uibtrWjscFCTqc" \
  -X PUT \
  -H 'Content-type: application/json' \
  -d '{"user": { "last_name": "Smith" }}' \
  https://api.record360.com/api/user/42

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate

{
  "user": {
    "id": "42",
    "username": "[email protected]",
    "first_name": "John",
    "last_name": "Smith",
    "external_id": "j_beeblebrox42",
    "created_at": "2016-05-23T22:16:43.000Z",
    "updated_at": "2016-05-23T22:16:43.000Z",
  }
}

Params

Param name Description
id
required

User ID, _externalid, or “self”

Validations:

  • Must be a String

user
required

User attributes

Validations:

  • Must be a Hash

user[username]
optional

Username or email address, must be globally unique

Validations:

  • Must be a String

user[password]
optional

Password

Validations:

  • Must be a String

user[first_name]
optional

First name

Validations:

  • Must be a String

user[last_name]
optional

Last name

Validations:

  • Must be a String

user[phone_number]
optional

Phone number

Validations:

  • Must be a String

user[active]
optional , nil allowed

Account enabled? (manager only)

Validations:

  • Must be one of: true, false, 1, 0.

user[location_id]
optional

Location ID (manager only)

Validations:

  • Must be a String

user[external_id]
optional

External ID (manager only)

Validations:

  • Must be a String

user[role]
optional

Role (manager only)

Validations:

  • Must be a String