getLabels
| Method | GET | ||
| Prod URL | https://irm.trustarc.com/server/api/v1/external/requests/{id}/labels | ||
| Headers | Authorization: Bearer <access_token from 'Token Access' section> | ||
| URL Parameters | Required Query Parameters | ||
| Name | Value | Description | |
id | string | id | |
| Sample Request | N/A | ||
| Sample Success Response | {
"labels": [
{
"id": "00000000-0000-0000-0000-000000018001",
"name": "Email Verification Pending",
"isCustom": false
}
]
}Where:
| ||
| Success Response | Code: 200 OK | ||
| Error Response |
| ||
saveCustomLabelByName
| Method | PUT | ||
| Prod URL | https://irm.trustarc.com/server/api/v1/external/requests/{requestId}/labels/name/{labelName} | ||
| Headers | Authorization: Bearer <access_token from 'Token Access' section> | ||
| URL Parameters | Required Query Parameters | ||
| Name | Value | Description | |
labelName | string (path) | labelName | |
requestId | string($uuid) (path) | requestId | |
| Sample Request | N/A | ||
| Sample Success Response | {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isCustom": true,
"name": "string"
} | ||
| Success Response |
| ||
| Error Response |
| ||
saveCustomLabelByID
| Method | PUT | ||
| Prod URL | https://irm.trustarc.com/server/api/v1/external/requests/{requestId}/labels/{labelId} | ||
| Headers | Authorization: Bearer <access_token from 'Token Access' section> | ||
| URL Parameters | Required Query Parameters | ||
| Name | Value | Description | |
labelId | string($uuid) (path) | labelId | |
requestId | string($uuid) (path) | requestId | |
| Sample Request | N/A | ||
| Sample Success Response | {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isCustom": true,
"name": "string"
} | ||
| Success Response |
| ||
| Error Response |
| ||