Skip to main content
PUT
Change a current-organization user role

Path Parameters

userId
string
required

The ID of the user whose current-organization role is changing.

Body

The updated role assignment.

Request schema for the Leadping API organization user request, including the fields clients can send.

userId
string | null

User ID to add, update, or remove from the organization.

email
string | null

Email address for the person represented by this organization user request.

role
enum<string>

Organization role assigned to the user.

Available options:
Owner,
Admin,
Agent

Response

Returns the organization member response.

API response containing organization user data returned to callers.

organization
object

The organization value for this organization user.

user
object

The user value for this organization user.

userEmail
string | null

The user email value for this organization user.

role
enum<string>

The role value for this organization user.

Available options:
Owner,
Admin,
Agent
createdByUserId
string | null

The created by user ID associated with this organization user.

removedAt
string<date-time> | null

The date and time for the removed at value on this organization user.

removedByUserId
string | null

The removed by user ID associated with this organization user.

lastUsedAt
string<date-time> | null

The date and time for the last used at value on this organization user.

licenseBillingStatus
string | null

The billing status for this user's organization license.

licenseQuantity
string<int64>

The quantity on the shared organization user license item after this change.

Pattern: ^-?(?:0|[1-9]\d*)$
licenseRenewalDate
string<date-time> | null

The renewal date used for this user's license proration.

name
string

The display name for the entity.

id
string

The unique identifier for the entity.

createdAt
string<date-time>

The date and time when the entity was created.

modifiedAt
string<date-time> | null

The date and time when the entity was last modified, if applicable.