Update Organization User

PATCH

/v1/organization_users/{userId}

The Update Organization User Role API allows you to modify the role of a specific user within an organization, identified by userId. This API is used to update the user’s permissions and responsibilities by changing their role, ensuring that their access level aligns with their current position and duties within the organization.

Request

Authorization

Add parameter in header

X-Jicoo-Api-Key

Example:

X-Jicoo-Api-Key: ********************

Path Params

userId

string

required

Body Params application/json

role

enum<string>

optional

Allowed values:

owneradminmemberrestricted

Example

{
  "role": "owner"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/v1/organization_users/' \
--header 'Content-Type: application/json' \
--header 'X-Jicoo-Api-Key;' \
--data-raw ''

Responses

🟢200OK

application/json

Body

data

object (OrganizationUser)

required

userId

string

required

Unique ID of the user

name

string

required

Name of the user

profileImage

string | null

required

Profile image URL of the user

required

Email of the user

color

string

required

Color preference of the user

slug

string

required

Slug for the user profile

role

enum<string>

required

Role of the user in the organization

Allowed values:

owneradminmemberrestricted

createdAt

string <date-time>

required

Creation time of the user profile

updatedAt

string <date-time>

required

Last update time of the user profile

Example

{
  "data": {
    "userId": "string",
    "name": "string",
    "profileImage": "string",
    "email": "user@example.com",
    "color": "string",
    "slug": "string",
    "role": "owner",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

Modified at 2024-08-28 10:57:25

Get Organization User

Create Organiztion Invitation