Skip to main content

​
Check contact unlock status

Check aggregate and per-person progress for a contact email unlock request. Use this endpoint after POST /external/contacts/unlock returns a task_id.

​
Endpoint

GET /external/contacts/unlock-tasks/:taskId

​
Authentication

See Authentication

​
Success status code

200 OK

​
Path parameters

NameRequiredTypeNotes
taskIdYesstringTask identifier returned by POST /external/contacts/unlock.

​
Response example

{
  "taskId": "901",
  "taskStatus": "completed",
  "items": [
    {
      "personnelId": "789",
      "status": "unlocked",
      "email": "jane.doe@example.com"
    },
    {
      "personnelId": "790",
      "status": "failed",
      "errorCode": "TASK_FAILED"
    }
  ]
}

​
Error responses

  • 401 Unauthorized
  • 404 Not Found

​
Notes

  • taskStatus is the aggregate batch status: pending, processing, completed, or failed.
  • email is returned only for items whose status is unlocked.