Skip to main content

Request contact email unlock

Request email unlock for a set of personnel ids within one event. Use this endpoint when the user has already identified specific people and wants their email access unlocked for one event.

Endpoint

POST /external/contacts/unlock

Authentication

See Authentication

Success status code

201 Created

Request body

NameRequiredTypeNotes
personnel_idsYesstring[]One or more personnel ids to unlock. Duplicate values do not increase the number of contacts processed.
event_idYesstringEvent identifier returned by event endpoints.

Response example

{
  "status": "accepted",
  "task_id": "901",
  "job_id": "901"
}

Error responses

  • 400 Bad Request
  • 401 Unauthorized
  • 402 Payment Required
  • 404 Not Found
  • 409 Conflict

Notes

  • 201 Created means the request was accepted, not that emails are already available.
  • Every personnel_id must belong to the supplied event_id.
  • Use Check contact unlock status with the returned task_id to monitor progress.