PATCH/spaces/api/v1/users/{userID}.json

Update a local spaces user.

Updates a user stored in the Spaces data store.

Path Params

  • Name
    userID
    Type
    integer
    required
    Description

Body Params

    • Name
      user
      Type
      object
      Description
      UserUpdate is the transformed projects user with updatable fields for the spaces data store

    Responses

    • Code
      200
      Type
      object
      Schema
      Description
      200 OK
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
    • Code
      404
      Type
      object
      Schema
      Description
      404 Not Found
    • Code
      500
      Type
      object
      Schema
      Description
      500 Internal Server Error

    Examples

    200 OK

    User
    {
      "user": {
        "LinkedCompany": {
          "company": {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        },
        "LinkedInstallation": {
          "installation": {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        },
        "avatar": "string",
        "createdAt": "2024-10-29T11:22:13.762Z",
        "createdBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "deletedAt": "2024-10-29T11:22:13.762Z",
        "deletedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "email": "string",
        "firstname": "string",
        "id": 0,
        "isAdmin": true,
        "isOnboarded": true,
        "lastname": "string",
        "preferences": {
          "emailEnabled": true,
          "showOnboardingHelp": true,
          "welcomeTextEnabled": true
        },
        "state": "string",
        "updatedAt": "2024-10-29T11:22:13.762Z",
        "updatedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "userType": "string"
      }
    }