v1

latestOpenAPI 3.0.12026-08-041753011.2 MB

User

Update a member's profile

patch/v1/workspaces/{workspaceId}/member-profile/{userId}

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Represents a workspace identifier across the system.

userIdstring required

Represents a user identifier across the system.

Example:5a0ab5acb07987125438b60f

Represents a user identifier across the system.

Request body

imageUrlstring

Represents an image url. A field that can only be updated for limited users.

namestring

This body field is deprecated and can only be updated for limited users. Represents name of the user and can be changed on the CAKE.com Account profile page.

removeProfileImageboolean

Indicates whether to remove profile image or not. A field that can only be updated for limited users.

Represents a day of the week.

workCapacitystring

Represents work capacity as a time duration in the ISO-8601 format. For example, for a 7hr work day, input should be PT7H.

Represents a list of days of the week.

Example request

{
  "imageUrl": "https://www.url.com/imageurl-1234567890.jpg",
  "name": "John Doe",
  "userCustomFields": [
    {
      "customFieldId": "5e4117fe8c625f38930d57b7"
    }
  ],
  "weekStart": "MONDAY",
  "workCapacity": "PT7H",
  "workingDays": "[\"MONDAY\",\"TUESDAY\",\"WEDNESDAY\",\"THURSDAY\",\"FRIDAY\"]"
}

Response

emailstring

Represents email address of the user.

hasPasswordboolean

Indicates whether user has password or none.

hasPendingApprovalRequestboolean

Indicates whether user has pending approval request.

imageUrlstring

Represents an image url.

namestring

Represents name of the user.

Represents a day of the week.

workCapacitystring

Represents work capacity as a time duration in the ISO-8601 format.

Represents a list of days of the week.

workspaceNumberinteger

Represents the number of workspace(s) the user is associated to.

Example response

{
  "email": "johndoe@example.com",
  "imageUrl": "https://www.url.com/imageurl-1234567890.jpg",
  "name": "John Doe",
  "userCustomFieldValues": [
    {
      "customField": {
        "allowedValues": [
          "New York",
          "London",
          "Manila",
          "Sydney",
          "Belgrade"
        ],
        "description": "This field contains a location.",
        "entityType": "USER",
        "id": "44a687e29ae1f428e7ebe305",
        "name": "location",
        "placeholder": "Location",
        "projectDefaultValues": [
          {
            "projectId": "5b641568b07987035750505e",
            "status": "VISIBLE"
          }
        ],
        "status": "VISIBLE",
        "type": "DROPDOWN_MULTIPLE",
        "workspaceId": "64a687e29ae1f428e7ebe303"
      },
      "customFieldId": "5e4117fe8c625f38930d57b7",
      "name": "race",
      "sourceType": "WORKSPACE",
      "type": "DROPDOWN_MULTIPLE",
      "userId": "5a0ab5acb07987125438b60f"
    }
  ],
  "weekStart": "MONDAY",
  "workCapacity": "PT7H",
  "workingDays": "[\"MONDAY\",\"TUESDAY\",\"WEDNESDAY\",\"THURSDAY\",\"FRIDAY\"]",
  "workspaceNumber": 3
}