Introduction

Welcome to the SenderWiz API Documentation 👋

SenderWiz offers a robust and flexible API that allows seamless integration with third-party platforms, custom applications, and internal tools. With this API, you can automate workflows, manage email campaigns, and access key SenderWiz functionalities programmatically.

Overview

The SenderWiz API provides all essential operations to power your integration needs — from creating campaigns and managing contacts to sending emails and retrieving reports.

By following industry-standard RESTful conventions, the API is simple to use, predictable, and developer-friendly.

HTTP Methods Used

SenderWiz API adheres to the REST architecture and uses standard HTTP methods:

  • POST – Used to create new resources

  • GET – Used to retrieve or list existing resources

  • PUT – Used to update existing resources

  • DELETE – Used to remove resources

⚠️ Ensure that your server or hosting provider supports PUT and DELETE methods. If you encounter an HTTP 403 Forbidden error during these operations, your server may be blocking these methods. Please review your server configuration or contact your hosting provider to allow them.

Authorization

Authentication is required for all API requests and is handled via API keys sent in custom headers.

Depending on the type of access required, use the appropriate header:

  • Customer Tasks: Use X-API-KEY

  • Admin Tasks: Use X-ADMIN-API-KEY

Make sure to keep your API keys secure and never expose them in public-facing applications.

Data Format

  • Requests: Data must be sent using form-data (multipart/form-data) encoding.

  • Responses: All API responses are returned in standard JSON format for easy parsing and integration.


Last updated