Chat / Platform API
Current version: v3
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Home
    /
    Chat
    /
    Platform API
    /
    Organization

    Update a member

    Updates the role of a specific member of an organization.


    HTTP request

    PATCH https://gate.sendbird.com/api/v2/organization_members/{member_id}
    

    Parameters

    The following table lists the parameters that this action supports.

    Required
    Parameter nameTypeDescription

    member_id

    int

    The unique ID of an organization member.


    Request body

    The following table lists the properties of an HTTP request that this action supports. The two properties shown below can't be requested at the same time. If a user requests both properties, the response returns an error.

    Optional
    Property nameTypeDescription

    predefined_role

    string

    Specifies a system role provided by default in an organization. Acceptable values are OWNER, ADMIN, BILLING, DESK_ADMIN, DESK_AGENT, CALL_USER, and DEFAULT.

    * Use either predefined_role or role for a request. If you use both parameters at the same time, the response returns an error.

    role

    string

    Role names customizable by the user.

    # when specifying a predefined role
    {"predefined_role": "ADMIN"}
    
    # when specifying a custom role
    {"role": "CUSTOM_ROLE_NAME"}
    

    Response

    If successful, this action returns a member resource in the response body.

    {
      "id": 14274,
      "role": "ADMIN",
      "created_at": "2020-12-10T06:12:52Z",
      "status": "ACTIVE",
      "user": {
        "id": 30003989,
        "email": "sample@sample.com",
        "date_joined": "2020-12-10T06:12:52Z",
    
        "is_active": true,
        "profile": {
          "id": 14388,
          "nickname": "sample_nickname"
        },
        "first_name": "Sample",
        "last_name": "Jack"
      },
      "organization": 13731,
      "organization_member_role": {
        "name": "ADMIN",
        "is_predefined": true
      }
    }
    

    In the case of an error, an error object is returned. A detailed list of error codes is available here.