SenderWiz API
HomepagePricingContact UsLoginSignup
  • Introduction
  • API URL and Key
  • Customer
    • Contact List
      • Get All Lists
      • Get One List
      • Create a List
      • Update a List
      • Copy a List
      • Delete a List
    • Fields
      • Get All List Fields
      • Get One List Field
      • Create a List Field
      • Update a List Field
      • Delete a List Field
      • Get All List Field Types
    • Segments
      • Get All List Segments
      • Get One List Segment
      • Get All Subscribers
      • Create a List Segment
      • Update a List Segment
      • Delete a List Segment
      • Get All List Segment Condition Operators
    • Subscribers
      • Get All Subscribers
      • Get One Subscriber
      • Search Subscriber by Email
      • Search by Email in All Lists
      • Search by Custom Fields in a List
      • Search Subscribers by Status
      • Get Blacklisted Subscribers
      • Get Confirmed Subscribers
      • Get Unconfirmed Subscribers
      • Get Unsubscribed Subscribers
      • Create a Subscriber
      • Create Subscribers in Bulk
      • Update a Subscriber
      • Update a Subscriber by Email
      • Create or Update a Subscriber
      • Unsubscribe a Subscriber
      • Unsubscribe a Subscriber by Email
      • Unsubscribe Subscriber from All Lists
      • Delete One Subscriber
      • Delete Subscriber by Email
    • Campaigns
      • Get All Campaigns
      • Get One Campaign
      • Create a Campaign
      • Update a Campaign
      • Copy a Campaign
      • Pause/Unpause a Campaig
      • Mark a Campaign as SENT
      • Delete a Campaign
      • Get Stats of a Campaign
    • Reports
      • Track Subscriber Click for Campaign
      • Track Subscriber Open
      • Track Subscriber Unsubscribe
    • Bounces
      • Get All Bounces
      • Create a Campaign Bounce
    • Countries
      • Get All Countries
      • Get All Zones of a Country
    • Templates
      • Get All Templates
      • Get One Template
      • Search Templates
      • Create a Template
      • Update a Template
      • Delete a Template
    • Subaccounts
      • Get All Subaccounts
      • Create a Subaccount
      • Update a Subaccount
      • Delete a Subaccount
      • Get Subaccount Permissions
      • Update Subaccount Permissions
    • Transactional Emails
      • Get All Transactional Emails
      • Get One Transactional Email
      • Create a Transactional Email
      • Delete a Transactional Email
  • Admin
    • Customer
      • Get All Customers
      • Get One Customer
      • Create a Customer
      • Update a Customer
      • Delete a Customer
      • Get All Customer Groups
      • Get All Timezones
    • Customer Login via Token
    • Customer Task via Admin API
Powered by GitBook
On this page
  • Overview
  • HTTP Methods Used
  • Authorization
  • Data Format

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.


NextAPI URL and Key

Last updated 1 month ago