Delete Schedule Job ID

Use this endpoint to delete a pending scheduled GDPR job by the ID.

services/v2/jobs/gdpr/[schedule-job-id].json

- URL (Path/Query) Params
No query params needed; the schedule-job-id is already a path param.

- Data Params
No data params

🚧

For Permissions, Requirements, and More Detailed Information:

Reference the GDPR Plugin Docs in the Non-Reference portion of the documentation.

Sample Request

Call:
curl -u : -H "Accept:application/json" -H "Content-Type:applcation/json" -X DELETE "https://apidocs.cloud.answerhub.com/services/v2/jobs/gdpr/.json" -v

curl 
-u answerhub:test123 
-H "Accept:application/json"
-H "Content-Type:applcation/json" 
-X DELETE "https://apidocs.cloud.answerhub.com/services/v2/jobs/gdpr/511.json"

Expected Responses

- Success Response:
Code: 200 
Content:  {execution id triggered}

- Error Response:

  • job already ran or running: HTTP/1.1 422 Unprocessable Entity
    {
    "error": "the job is either running or has run already."
    }
  • job does not exist / already deleted HTTP/1.1 404 Not Found
    {
    "error": "Not found"
    }
  • job id invalid, (eg: /v2/jobs/gdpr/511s.json ) HTTP/1.1 400 Bad Request

{
"error": "The provided 'job id(s)' is/are invalid"
}

Sample Response

Successful Response:

{
  execution id triggered 
}

Error Response Job Already Ran Or Running: HTTP/1.1 422 Unprocessable Entity

{
   "error": "the job is either running or has run already."
}

Error Response Job Does Not Exist / Already Deleted HTTP/1.1 404 Not Found

{
   "error": "Not found"
}

Error Response Job ID Invalid, (eg: /v2/jobs/gdpr/511s.json ) HTTP/1.1 400 Bad Request

{
   "error": "The provided 'job id' is/are invalid"
}
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!