Skip to main content

Schema

Location​

You can access API at https://devmailer.vercel.app/api

Summary objects​

When retrieving a list of objects, an abbreviated or summary version of that object is returned - i.e., a subset of its attributes. To get a full detailed version of that object, fetch it individually.

HTTP Verbs​

The DevMailer API uses HTTP verbs appropriate to each action.

VerbsDescription
GETRetrieving resources
POSTCreating resources
PUTUpdating resources
DELETEDeleting resources

Error​

If an error occurs, whether on the server or client side, the error message(s) will be returned in as object. For example:

Status Code: 400

    {
"message": "Payload is empty. Please you have provide the required fields correctly!",
}
Common Status CodesDescription
200 - OKEverything worked as expected
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter
401 - UnauthorizedInvalid Access Token
403 - ForbiddenMissing permissions to perform request
404 - Not FoundThe requested resource doesn’t exist
500, 503Something went wrong on server