PUT /api/v4/users
Update User. Last update: 22/11/24

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  "user": {
    "email": "kruchina.vadim@gmail.com",
    "first_name": "Vadim",
    "last_name": "Kruchina",
    "role_in_organization": "Role",
    "state": "CA",
    "city": "Los Angeles",
    "avatar_image": "s3_key",
    "current_password": "CURRENT_PASSWORD",
    "password": "NEW_PASSWORD",
    "password_confirmation": "NEW_PASSWORD",
    "mode": "light",
    "workspace_attributes": {
      "id": 1,
      "name": "Scrum Launch",
      "organization_type": "Private High School"
    }
  }
}

Success response body ↑

{
  "id": 14,
  "email": "kruchina.vadim@gmail.com",
  "first_name": "Vadim",
  "last_name": "Kruchina",
  "role_in_organization": "Role",
  "state": "CA",
  "city": "Los Angeles",
  "avatar_image": "https://gipper-college-logos-development.s3.amazonaws.com/s3_key",
  "enable_content_request": true,
  "payed_credit_card": false,
  "fieldhouse_user": false,
  "role": "super_admin",
  "stripe_admin": true,
  "auth_token": "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNCwiZXhwIjoxNjU5MjU3Nzk1fQ.dxcqT4_SighZdUUmIiFU4b-_1S9SEj6xf_OSgxOGo1Y",
  "team_exists": true,
  "can_use_site": true,
  "workspace_role": {
    "id": 1,
    "name": "owner"
  },
  "workspace": {
    "id": 1,
    "name": "updated2",
    "trial_type": "Two-week",
    "trial_status": "in_progress",
    "organization_type": "["Public High School", "Private High School", "College/University", "Club/Youth Sports", "Other/Not Listed"]",
    "custom_organization_type": "CUSTOM_TYPE",
    "plan": [
        "Premier"
    ],
    "subscribed": false
  },
  "payment_sources": [
    {
      "id": 1,
      "last_4": "4242",
      "expiration_month": 3,
      "expiration_year": 2023
    },
    {
      "id": 2,
      "last_4": "4242",
      "expiration_month": 3,
      "expiration_year": 2023
    }
  ],
  "user_notifications": {
    "team_admin": [
      {
        "id": 1,
        "notification": {
          "title": "Heads Up! You have been added to a new team",
          "body": "<p>Your workspace member: kruchina.vadim@gmail.com has left your workspace.</p><p>This user was the admin of the team: MyTeam</p><p>To prevent the team from being removed, you have been added to this team and have been appointed as the team admin. If you do not wish to be a part of this team, please visit the team, appoint a new team admin, and leave the team.</p>",
          "link": {
            "text": "Go to Teams",
            "path": "/teams"
          }
        }
      },
      ...
    ],
    invites: [
      {
        "id": 2,
        "notification": {
          body: "<p>Vadym Kruchyna has invited you to join the Scrum Launch workspace</p>"
        }
      },
      ...
    ]
  },
  "hidden_notifications": []
}

Params

Param name Description
user
required

Validations:

  • Must be a Hash
user[email]
optional

Validations:

  • Must be a String
user[first_name]
optional

Validations:

  • Must be a String
user[last_name]
optional

Validations:

  • Must be a String
user[role_in_organization]
optional

Validations:

  • Must be a String
user[state]
optional

Validations:

  • Must be a String
user[city]
optional

Validations:

  • Must be a String
user[current_password]
optional

Validations:

  • Must be a String
user[password]
optional

Validations:

  • Must be a String
user[password_confirmation]
optional

Validations:

  • Must be a String
user[plan_interest]
optional

This property indicates what plan the prospect attempted to purchase when they abandoned their cart

Validations:

  • Must be a String
user[platform_plan]
optional

Validations:

  • Must be a String
user[abandoned_cart_date]
optional

This is the date the contact exited the paid flow prior to completing payment.

Validations:

  • Must be a Date
user[purchase_date]
optional

This is the date the user purchases a paid plan

Validations:

  • Must be a Date
user[po_request_date]
optional

The date the user requests a PO invoice

Validations:

  • Must be a Date
user[organization_role]
optional

Validations:

  • Must be a String
user[custom_organization_role]
optional

Validations:

  • Must be a String
user[how_did_you_know_about_us]
optional

Validations:

  • Must be a String
user[completed_user]
optional

only when user created from stripe completed registration

Validations:

  • Must be one of: true, false, 1, 0.
user[walkthrough_seen]
optional

Validations:

  • Must be one of: true, false, 1, 0.
user[mode]
optional

Validations:

  • Must be one of: dark, light.
user[workspace_attributes]
optional

Validations:

  • Must be a Hash
user[workspace_attributes][id]
required

Validations:

  • Must be a Integer
user[workspace_attributes][name]
optional

Validations:

  • Must be a String
user[workspace_attributes][organization_type]
optional

Validations:

  • Must be one of: Public High School, Private High School, College/University, Club/Youth Sports, Other/Not Listed.
user[workspace_attributes][custom_organization_type]
optional

Validations:

  • Must be a String