Members

Update an organization member

Changed on

Update a member's role within an organization. Requires manage permission (owner or admin). The organization owner's role cannot be changed.

patch/v1beta/organizations/{organization_id}/members/{user_id}

Request

  • Base URL
    https://api.factify.com
  • URL
    https://api.factify.com/v1beta/organizations/{organization_id}/members/{user_id}
  • Auth
    HTTP bearer

Path parameters

organization_idstring required

Organization the member belongs to. Pattern: org_[0-9a-hjkmnp-tv-z]{26}

user_idstring required

User account ID of the member to update. Pattern: user_[0-9a-hjkmnp-tv-z]{26}

Request body

role'owner' | 'admin' | 'member' required

Response

Success

Example response

{
  "member": {
    "user": {
      "id": "user_01h2xcejqtf2nbrexx3vqjhp41"
    }
  }
}

Changes

    • info

      api tag Members added

    • info

      api tag Organizations removed

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property // from the response with the status

    • info

      the // response's property pattern was changed from ^(user|svc)_[0-9a-hjkmnp-tv-z]{26}$ to ^user_[0-9a-hjkmnp-tv-z]{26}$ for the status

    • info

      added the required property // to the response with the status