Sign up for free
View as Markdown

Cancel Enrichment

POST/v2/enrichments/{id}/cancel

Cancels an enrichment that is not finished; credits already spent stay spent. A job already completed, failed or cancelled answers 409 invalid_state. Free; a poll (0 rate-limit units, per-second window only).

Path parameters

  • idstringrequired

    The enrichment id: the id that a create answers and GET /v2/enrichments lists.

Responses

  • 200 The job, cancelled.
  • 400 Malformed id (VALIDATION_ERROR).
  • 401 Missing, unknown or inactive credentials (UNAUTHORIZED).
  • 404 No enrichment with this id in the workspace (NOT_FOUND).
  • 409 The job is already finished (CONFLICT, invalid_state; payload.status names its state).
  • 429 Over the poll rate limit (RATE_LIMIT); wait Retry-After seconds. Sent only where rate limits are enforced for the caller channel.
  • 500 Unexpected server error.

For error handling see Errors. Response objects are described in Person object and Company object.