Search

Add Custom Labels Associated with Requests

getLabels
Method
GET
Content-Type
application/json
URL
https://irm.trustarc.com/server/api/v1/external/requests/{id}/labels
Headers
Authorization: Bearer <access_token>
Query Parameters
Required Query Parameters
Name Value Description
idRequired string The request ID.
Sample Request
N/A
Sample Success Response
{
  "labels": [
    {
      "id": "00000000-0000-0000-0000-000000018001",
      "name": "Email Verification Pending",
      "isCustom": false
    }
  ]
}

Where:

labels — List of label objects.
Response Codes
Code: 200 OK
Code: 401 Unauthorized
Code: 403 Forbidden
Code: 404 Not Found
saveCustomLabelByName
Method
PUT
Content-Type
application/json
URL
https://irm.trustarc.com/server/api/v1/external/requests/{requestId}/labels/name/{labelName}
Headers
Authorization: Bearer <access_token>
Query Parameters
Required Query Parameters
Name Value Description
labelNameRequired string (path) The name of the label.
requestIdRequired string($uuid) (path) The request ID.
Sample Request
N/A
Sample Success Response
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isCustom": true,
  "name": "string"
}
Response Codes
Code: 200 OK
Code: 201 Created
Code: 401 Unauthorized
Code: 403 Forbidden
Code: 404 Not Found
saveCustomLabelByID
Method
PUT
Content-Type
application/json
URL
https://irm.trustarc.com/server/api/v1/external/requests/{requestId}/labels/{labelId}
Headers
Authorization: Bearer <access_token>
Query Parameters
Required Query Parameters
Name Value Description
labelIdRequired string($uuid) (path) The label ID.
requestIdRequired string($uuid) (path) The request ID.
Sample Request
N/A
Sample Success Response
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isCustom": true,
  "name": "string"
}
Response Codes
Code: 200 OK
Code: 201 Created
Code: 401 Unauthorized
Code: 403 Forbidden
Code: 404 Not Found
TrustArc  ·  IRM — Custom Labels Associated with Requests API Reference  ·  support.trustarc.com