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

Authorizations

Authorization
string
header
required

Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_.

Path Parameters

userId
string
required

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

Body

The updated role assignment.

Defines the fields clients can send when working with organization user.

userId
null | string

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

email
null | string<email>

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

role
enum<string>

Identifies an organization member's access level and permission scope within Leadping.

Available options:
Owner,
Admin,
Agent

Response

Returns the organization member response.

Describes organization user data returned by Leadping.

organization
object

Provides a compact API reference to another resource using its stable identifier and human-readable display name.

user
object

Provides a compact API reference to another resource using its stable identifier and human-readable display name.

userEmail
null | string<email>

User email for this organization user.

role
enum<string>

Identifies an organization member's access level and permission scope within Leadping.

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

The created by user ID associated with this organization user.

removedAt
null | string<date-time>

UTC timestamp for removed at on this organization user.

removedByUserId
null | string

The removed by user ID associated with this organization user.

lastUsedAt
null | string<date-time>

UTC timestamp for last used at on this organization user.

licenseBillingStatus
null | string

The billing status for this user's organization license.

licenseQuantity
null | integer<int64>

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

licenseRenewalDate
null | string<date-time>

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

name
string

Human-readable display name of the resource.

id
string

Stable unique identifier of the resource.

createdAt
string<date-time>

UTC timestamp when the resource was created.

modifiedAt
null | string<date-time>

UTC timestamp when the resource was last modified, or null when it has not been updated.