workspace-membership

Changed on
post/workspaces/{workspaceSlug}/members/assign

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/members/assign
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

Request body

role'OWNER' | 'ADMIN' | 'MEMBER' required

New role to assign (OWNER, ADMIN, MEMBER)

userIdinteger required

User ID of the member to update

Response

OK

createdAtstring date-time required

Timestamp when the membership was created

eligibleForPracticeReviewboolean required

Whether this linked human member can be selected for practice-review coverage

hiddenboolean required

Whether the member is left out of workspace activity

role'OWNER' | 'ADMIN' | 'MEMBER' required

Role of the user in this workspace (OWNER, ADMIN, MEMBER)

userIdinteger required

Unique identifier of the user

userLoginstring required

Login/username of the user

userNamestring

Display name of the user

Changes

  • 9662502b2cc4Revision changes
    • breaking

      for the path request parameter workspaceSlug, the minLength was increased from 0 to 3

    • warning

      for the path request parameter workspaceSlug, the maxLength was set to 51

    • warning

      changed the pattern of the path request parameter workspaceSlug from ^[a-z0-9][a-z0-9-]{2,50}$ to ^(?!.*--)[a-z0-9][a-z0-9-]{1,49}[a-z0-9]$

  • c90ade77d2faRevision changes
    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status