Operation of DebugMail API

The API will allow your system to interact with DebugMail. With this functionality you will be able to automate necessary actions in your application. From this article you will learn about the location of the API docs, supported requests, scenarios, and how to get started with DebugMail API.

Where to locate the API documentation on the site
Supported HTTP requests in DebugMail API
What are the features of the DebugMail API
— Possible scenarios for using the DebugMail API
Getting started with DebugMail API

Where to locate the API documentation on the site

To access detailed documentation on API DebugMail, use this link. 

You can also find it in the bottom section of the page in the Info block, in the API Docs line. 

Alternatively, the documentation link is available in the account Control panel in the API Rules section.

Supported HTTP requests in DebugMail API

DebugMail supports the following HTTP requests:

• POST to create a new resource.
• PATCH to partially update a resource.
• PUT to update a resource.
• GET to retrieve a resource or a list of resources.
• DELETE to delete a resource.

What are the features of the DebugMail API

Through the API, you can execute the following commands:

• Projects: create a new project, update or delete a project, reset password, and set project priority.
• Team members: get a list of all team members, change a team member’s role or remove them from the team.
• Teams: create, update, get, or delete a team.
• Users: get and update user data, login or logout, update password.
• Project members: add, remove, or get users in a project.
• Mails: get all project emails, view an email, get a short link to an email, forward an email, delete an email or all project emails.
• Invitations: get information, create an invitation, accept an invitation.
• Forwarding rules: create, update, delete, get project information, delete all project rules, list all project rules.
• Billing: get payment source information, get payment information, get customer information, view all team payments.

Possible scenarios for using the DebugMail API

• Confirm that emails are received by the project
• Ensure that the email forwarding rules to recipients are accurate
• Verify that the status of projects is up-to-date
• Manage the team and its members, etc.

Getting started with DebugMail API

Right on the documentation page https://app.debugmail.io/api-public/docs/, you can fire off requests without any hassle.

1. First, you need to get the token using /users/login and account details (password and login).

2. You get a token when you send a login request.

3. To run the request, you need to add the Authorization in Header and add your token to its value (don’t forget to manually add the prefix).

4. After that, send a request to any endpoint.

If you have any questions or need help, please email us.

To ensure reliable testing of email functionality in your project, make sure to explore DebugMail integration through SMTP. For more information on this integration, click on the following link: https://debugmail.io/how-to/how-to-integrate-debugmail-for-testing-email-as-smtp/.