Developer API Reference

Delete Record API

Delete your record info.

ImportantOnce deleted, you cannot recover it.

Root

https://api.ttskit.com/v1

Route

/record

Request Type

DELETE

Request Headers

Below are the list of Accepted Request Headers if you are trying to Delete Record.

Request Header	Value	Required
X-Master-Key	<API_KEY>	Yes

X-Master-Key Required

You will need this Key to access mostly any API end-point on TTSKit. You could find the key on the API Key page.

Query String Parameters

Query String Parameter	Value	Required
recordId	<Record Id>	Yes

recordId Required

recordId is required to your Record Id.

Code Samples

cURL
Java
JavaScript (ES6)
Python 3
Ruby

curl -v\
    -H 'X-Master-key: <YOUR_API_KEY>' \
    -d '{"recordId": <RECORD_ID>}' \
    --request DELETE \
    https://api.ttskit.com/v1/record

    HttpDelete del = new HttpDelete("https://api.ttskit.com/v1/record");

    List<NameValuePair> urlParameters = new ArrayList<>();
    urlParameters.add(new BasicNameValuePair("recordId", "<RECORD_ID>"));

    put.addHeader("X-Master-Key", "<YOUR_API_KEY>");
    put.setEntity(new UrlEncodedFormEntity(urlParameters));

    try (CloseableHttpClient httpClient = HttpClients.createDefault();
            CloseableHttpResponse response = httpClient.execute(del)) {

        System.out.println(EntityUtils.toString(response.getEntity()));
    }

let req = new XMLHttpRequest();

req.onreadystatechange = () => {
    if (req.readyState == XMLHttpRequest.DONE) {
        console.log(req.responseText);
    }
};

req.open("DELETE", "https://api.ttskit.com/v1/record", true);
req.setRequestHeader("X-Master-Key", "<YOUR_API_KEY>");
req.send(JSON.stringify({"recordId": <RECORD_ID>}));

import requests
url = 'https://api.ttskit.com/v1/record'
headers = {
    'X-Master-Key': '<YOUR_API_KEY>'
}
data = {
    'recordId': <RECORD_ID>
}

req = requests.delete(url, json=data, headers=headers)
print(req.text)

require 'net/http'
require 'json'

uri = URI("https://api.ttskit.com/v1/record")
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
req = Net::HTTP::Delete.new(uri)
req['X-Master-Key'] = '<YOUR_API_KEY>'
req.body = {recordId: <RECORD_ID>}.to_json


http.request(req)
end

puts res.body

Request Response

Success Status Code: 200

{
    "code": 200,
    "message": "Success.",
    "status": "success",
    ...
}

Error Status Code: 400, 401, 402, 404

{
    "code": 400,
    "message": "<Error Message>",
    "subMessage": "<Error Message Detail>",
    "status": "error"
}

For more information on the error codes & errors you might possibly encounter, refer to the below section.

Error Reference

400 Bad Request
401 UnAuthorized
402 Payment Required
404 Not Found

Invalid Route

To solve this issue, simply provide the correct Route.

Ensure your data complies with data constraints

You can refer to "subMessage" for more details.

You need to pass X-Master-Key in the header

You'll encounter this error if you are not passing the X-Master-Key header which is required to authenticate your request. In-order to fix this, pass the X-Master-Key header with a value of the API Key which you can find on the API Keys page.

The Id does not belong to your account

X-Master-Key passed does not have permission to read the record.

Currently, The API is only supported for premium users. Upgrade to Premium plan https://ttskit.com/pricing to use these features

You need to upgrade your account to the Premium Plan to use these features.

Record not found.

Check if the Id is valid and belongs to your account.

DEVELOPERS API REFERENCE (v1.0)