This API call is used to remove a Veritone Hire vacancy matching all the supplied filters from every job board it is currently live on.
It is strongly recommended that the filter criteria used are custom fields and that these custom fields represent unique values in the ATS/CRM system integrating with Veritone Hire. This ensures the integrating party can guarantee which vacancy operations are performed upon - particularly Delete.
Request
Method: POST
Endpoint:
https://beanwidget.adcourier.com/distro/delete
Content Type: application/json
Body:
Request Fields
| Level | Field | Type | Mandatory | Example Values | Notes |
|---|---|---|---|---|---|
| 1 | authentication | object | Y | ||
| 1.1 | api_key | string | Y | Unique API key for each client, supplied by Veritone Hire | |
| 1.2 | time | string | Y | epoch value (as string) | |
| 1.3 | signature | string | Y | SHA256/HMAC message digest encoded with shared secret key | |
| 2 | identification | object | Y | ||
| 2.1 | client_id | string | Y | AdCourier client id | |
| 2.2 | adc_username | string | Y | AdCourier (ADC) username | |
| 3 | transaction | object | |||
| 3.1 | filters | object | Y | The filters object must contain either: a job_reference string; or a custom_fields array with at least one element. | |
| 3.1.1 | job_reference | string | Y (if custom field is not used) | ||
| 3.1.2 | custom_fields | array list | N | ||
| 3.1.2.1 | name | string | Y | ATS_Job_Id | |
| 3.1.2.2 | value | string | Y | A12345 |
Response Fields
| Level | Field | Type | Mandatory | Example Values | Notes |
|---|---|---|---|---|---|
| 1 | success | boolean | Y | 1 or 0 | |
| 2 | message | string | Y (In case of success) | ||
| 3 | data | object | Y (In case of success) | ||
| 3.1 | channels | array list | Y | ||
| 3.1.1 | channel | string | Y | ||
| 3.1.2 | status | string | Y | Successful | Failed | |
| 4 | error | string | Y (In case of error) |