delete https://api.pre-prod.ozonetel.com/ca_apis/deleteScheduledData
Delete Scheduled Data API is used to delete the scheduled data inserted in the backend. Data is deleted based on row ID. A sequence of numbers can be deleted in a single request by passing the range of row IDs.
To use this API with the help of a token, follow these steps:
- Generate the Token: Use the 'Generate Token' API to obtain an authentication token.
- Enter the Token ID: Navigate to the right section of this page, under the 'AUTHORIZATION' tab. Here, input the generated token ID.
- With the token entered, pass the below header and body parameters:
Header parameters
| Parameter | Description |
|---|---|
| Content-Type | application/json |
Body Params
{
"userName":"xxxxx",
"rowId":"xxxx"}
| Parameter | Description |
|---|---|
| userName | Your CouldAgent account username |
| rowId* | Can be retrieved from Schedule Data status API |
Note
- Data can be deleted in below methods by passing desired row_id values
- Single record (example: row_id=1)
- Multiple numbers separated by commas ( example: row_id=2,3,5,6)
- Range of numbers by passing rage (example: row_id=3-10)
- Parameters with ‘*’ are considered to be mandatory parameters.
Possible responses
| Success response | "status": "success" "message": { |
| Invalid api_key | "status": "error" "message": "No data found" |
| Missing row_id | "status": "error" "message": "Mandatory parameter row_id is missing |
| Invalid row_id | "status": "error" "message": "No data found" |