- DarkLight
Check Profile Deletion Job Status
- DarkLight
Overview
This API allows you to check the status of a profile deletion request using the Profile ID. It helps determine whether the deletion request has been successfully processed.
Endpoint URL
The API endpoint used to check the deletion job status is:
/cxs/profile-delete-job/{profile_id}
HTTP Method
The method to be used for the request:
GET
Request Body Structure
This API does not require a request body. The deletion job is identified using the Profile ID passed as a path parameter in the endpoint URL.
Request Field Descriptions
This table outlines the required fields for the API request, including their types, whether they are mandatory, and their descriptions.
Field Name | Data Type | Required | Description |
|---|---|---|---|
profile_id | String | Yes | Unique identifier of the profile whose deletion status is being queried. |
Sample Response
{
"jobId": "2ddfb587-93d8-4422-8744-6335540f650b",
"status": "SUCCESS",
"updatedAt": "2026-01-14 04:09:09.536000"
}Response Field Description
This table outlines the response fields for the API request, including their types, whether they are, and their descriptions.
Field Name | Data Type | Description |
|---|---|---|
jobId | String | Unique identifier associated with the profile deletion job. |
status | String | Indicates the status of the deletion job. |
updatedAt | Date | Date and time when the job status was last updated. |
Limits
The frequency of status checks may be subject to system rate limits.
Error Response
Error Response | Description |
|---|---|
401 – Unauthorized | Indicates that the API request is not authenticated. |
400 – Bad Request | The input format is incorrect. Refer to the documentation for the correct format. |
405 – Method Not Allowed | Indicates that the HTTP method used in the request is not allowed for the specified resource. |
429 – Too Many Requests | Indicates that the client has exceeded the allowed number of requests within a given time frame. |