API ReferencePlatform
Back to Platform

PATCH /roles/{id}

PATCH
/roles/{id}

PATCH operation for /roles/{id}

Authorization

ApiKeyAuth
Authorization<token>

API key authentication. Format: Your API key (no "Token" prefix needed)

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://dev-rest.onboard.io/roles/string" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "description": "string",    "role_type": "internal"  }'
{
  "id": 1,
  "name": "string",
  "description": "string",
  "created_at": "2021-01-01T00:00:00Z",
  "role_type": "internal",
  "order": 1,
  "created_by": "string"
}
Empty
Empty
Empty

How is this guide?

GET /roles/{id} GET

GET operation for /roles/{id}

DELETE /roles/{id} DELETE

DELETE operation for /roles/{id}