Q3 Roadmap: Embedded Notifications, Embedded Commissions, Tips and more!

Update a specific role

PATCH

/api/organizations/{organization_id}/roles/{id}

Updates the details of a specific role by its ID.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/organizations//roles/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Senior Manager",
    "hourlyWage": 30
}'

Response Example

200 - Success

{
    "id": "role_001",
    "name": "Senior Manager",
    "organizationId": "org_12345",
    "hourlyWage": 30,
    "active": true,
    "createdAt": "2023-10-27T09:00:00Z",
    "updatedAt": "2023-10-27T11:00:00Z",
    "deletedAt": null
}

Request

Path Params

organization_id

string

required

The unique identifier of the organization to which the role belongs.

Example:

org_12345

string

required

The unique identifier of the role to update.

Example:

role_001

Body Params application/json

name

string

optional

hourlyWage

number

optional

Examples

Responses

🟢200OK

application/json

The role was updated successfully.

Body

active

boolean

required

createdAt

string <date-time>

required

deletedAt

string <date-time> | null

required

hourlyWage

number | null

required

string

required

name

string

required

organizationId

string

required

updatedAt

string <date-time>

required

🟠400Bad Request

🟠404Record Not Found

Modified at 2025-01-05 16:12:53

Retrieve a specific role

Delete a specific role