Add Custom Labels Associated with Requests

getLabels

MethodGET
Prod URLhttps://irm.trustarc.com/server/api/v1/external/requests/{id}/labels
HeadersAuthorization: Bearer <access_token from 'Token Access' section>
URL ParametersRequired Query Parameters
NameValueDescription
idstringid
Sample RequestN/A
Sample Success Response
{
  "labels": [
    {
      "id": "00000000-0000-0000-0000-000000018001",
      "name": "Email Verification Pending",
      "isCustom": false
    }
  ]
}
Where:
  • labels – list of label objects
Success ResponseCode: 200 OK
Error Response

Code: 401 Unauthorized

Code: 403 Forbidden

Code: 404 Not Found

 

saveCustomLabelByName

MethodPUT
Prod URLhttps://irm.trustarc.com/server/api/v1/external/requests/{requestId}/labels/name/{labelName}
HeadersAuthorization: Bearer <access_token from 'Token Access' section>
URL ParametersRequired Query Parameters
NameValueDescription
labelName

string

(path)

labelName
requestId

string($uuid)

(path)

requestId
Sample RequestN/A
Sample Success Response
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isCustom": true,
  "name": "string"
}
Success Response

Code: 200 OK

Code: 201 Created

Error Response

Code: 401 Unauthorized

Code: 403 Forbidden

Code: 404 Not Found

 

saveCustomLabelByID

MethodPUT
Prod URLhttps://irm.trustarc.com/server/api/v1/external/requests/{requestId}/labels/{labelId}
HeadersAuthorization: Bearer <access_token from 'Token Access' section>
URL ParametersRequired Query Parameters
NameValueDescription
labelId

string($uuid)

(path)

labelId
requestId

string($uuid)

(path)

requestId
Sample RequestN/A
Sample Success Response
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isCustom": true,
  "name": "string"
}
Success Response

Code: 200 OK

Code: 201 Created

Error Response

Code: 401 Unauthorized

Code: 403 Forbidden

Code: 404 Not Found