Route: https://api.kayran.live/DeletePayload
This function allows you to Delete a Payload from your Server.
Roles Required: Admin. Users can only Delete Payloads they created.
Request Syntax
{
"apiKey": "String",
"payloadId": "String"
}
Request Parameters
Parameters being used in the Request
Parameter Name :
apiKey
Parameter Usage and Options :
Your Kayran given API Key.
How do I get it ? :
Located in the “Profile” section.
Note : by default, the “API Status” is enabled, unless, the Admin has disabled it in the “Server Settings” section.
Type :
String
Is it Optional ? :
No.
Parameter Name :
payloadId
Parameter Usage and Options :
The ID of the Payload you wish to Delete.
How do I get it ? :
Use GetPayloads to fetch all Payloads. Then, fetch the value of the key ‘uuid’ of the desired Payload.
Type :
String
Is it Optional ? :
No.
Successful Response
{
“Error”: 0,
“Function”: “DeletePayload”,
“Data”: “Payload Deleted.”
}
Errors and their Possible Causes
For more information, please refer to the General Errors section.