Batches

Cancel or delete a file job

A job that has not started is cancelled; any reserved credit is returned. A finished job is deleted with its files. A job being processed cannot be stopped (409 batch_in_progress).

delete/api/v1/batches/{batch}

Request

  • Base URL: https://namegender.com
  • URL: https://namegender.com/api/v1/batches/{batch}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Path parameters

batchstring required
Example:B-7K2M9QX4TA

Job ID, as returned when the job was created (B-XXXXXXXXXX).

Response

Cancelled or deleted.

Changes

No recorded changes to this operation across all 1 revision of this API.