Delete (DELETE)

Use the DELETE method to delete a record.

uniqueId - The uniqueId is required to delete the record.

Request data#

HTTP method: DELETE

URL format: https://baseUrl/versionNumber/customEndpointRoute/userEndpoint?key=apiKey&uniqueId=uniqueId

Example:

https://app.yawe.dev/api/1/ce/examples/unsecure-endpoint?key=d59eb2859c284168ac48aef65046d5dd&uniqueId=45e964d5b6ed49b1a2e14d8ac724109e

Request Cookies#

HeaderDescriptionRequired
yawe_access_tokenThe Access token is required for secure endpoints.

It is obtained when doing a login. To automatically include it in the request you need to set the following property:

// using fetch
{ credentials: 'include' }
// using axios
{ withCredentials: true }

For more information check Secure Endpoints.

No

Request Parameters#

The following table describes the Request parameters.

ParameterDescriptionRequired
baseUrlBase url for calling the API.

Value: app.yawe.dev/api

Yes
versionNumberService version.

Value: The current value is 1.

Yes
customEndpointRouteThe route which identifies custom endpoints.

Default value: ce

Yes
userEndpointThe endpoint name generated by the user.

Value: the name created at https://app.yawe.dev

Yes
apiKeyThe API Key of the project.Yes
uniqueId_uniqueId_ of the record to be deleted.Yes
masterKeyOverrides the need for Access tokens or restrictions applied to Authentication endpoints.

Don't use this key in your client application.

For more information please refer to projects.

Value: the masterKey created at https://app.yawe.dev.

No

Usage example:

const url = "https://app.yawe.dev/api/1/ce/examples/unsecure-endpoint?key=d59eb2859c284168ac48aef65046d5dd&uniqueId=45e964d5b6ed49b1a2e14d8ac724109e";
fetch(url, {
method: 'DELETE',
})

Response data#

Error codes#

Error codeDescription
400Possible reasons:
  • Endpoint or API Key not valid.
401If the endpoint is secured and the access token is missing or is not valid.

It may also return this error if the user no longer exists.

403Missing API Key, not allowed origin or disallowed request without orign.

Successful response#

{
deleted: true,
message: 'Data deleted.'
}