API Reference

Update a company role

patch
https://api.cardda.com/v1/companies//company_roles/

Updates a company role's name/description and, when a permissions
array is supplied, replaces the role's permission set. If any supplied
permission id does not exist a 404 is returned.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The UUID of the company the nested resource belongs to.

string
required

The id of the resource. This is a UUID for most resources, but for user endpoints it is the user's Firebase UID (an opaque string), so no uuid format is asserted here.

Body Params
string
string
permissions
array of uuids

Full replacement set of permission ids for the role.

permissions
Headers
uuid
required

UUID of the company on whose behalf the request is made. Required for every Organization endpoint.
See The company-id header for details on how to obtain
a value for this header and the error responses to expect when it is missing or invalid.

Responses

401

Unauthorized

404

Company role or a supplied permission not found

422

Validation failed

Updated 4 days ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 days ago

Did this page help you?