Getting Started

v1

Blend Product: Marketing Automation Platform API Overview

Introduction

The Blend API provides a robust platform for managing marketing campaigns through WhatsApp. It offers comprehensive features for message delivery tracking, and error reporting. The endpoints are designed to facilitate seamless integration with your applications, allowing for efficient campaign execution and data analysis.

Prerequisites and Requirements

Before using the API, ensure the following:

1. Contact Us

   • Reach out to our sales team at [[email protected]] to discuss your use case and start the onboarding process.

2. Portal Configuration

   • Log in to our portal and complete the required setup steps, as outlined below.

Step-by-Step Setup

1. Compliance

• Review and agree to our Terms and Conditions, ensuring adherence to our policies and guidelines for using the API.

2. Facebook Business Manager (FBM)

• Ensure that your Facebook Business Manager account is fully set up and operational.

• This is required for connecting your WhatsApp Business Account (WABA).

3. Embedded Sign-Up

• Use our embedded sign-up process to easily onboard to the WhatsApp Business Platform.

• This step allows you to link your WABA to our platform.

4. WhatsApp Account Message Testing

• Test your messages to verify:

  • Profile Appearance: Ensure your business profile is accurately displayed.

  • Chat Thread Headers: Confirm message headers and branding consistency.

• This step helps ensure professionalism and alignment with your business objectives.

5. Request a WhatsApp Official Business Account (OBA)

• Submit a request for an official business account to unlock additional features and build trust with your audience.

API Access

1. Generate Your API Key

Blend Portal: Generate API Key

• Once you’ve completed all the setup steps above, log in to our portal and navigate to the API Key Management section.

• Generate your API Key, which will be used to authenticate your requests.

2. Explore the Dashboard

• Optionally, you can use our dashboard to manage configurations, view reports, and test API features before integrating them into your system.

Ready to Start?

Once everything is set up, you’re ready to use the WhatsApp Message API to engage with your audience. For detailed API documentation, refer to the developer guide or contact our support team for assistance.

Core Features

1. Message Delivery and Analytics

   • Monitor message delivery statuses (sent, delivered, read, or failed).

   • Analyze campaign performance with key metrics and trends.

2. Error Reporting

   • Detailed error descriptions for failed messages, enabling quick troubleshooting.

Key Endpoints

Authentication

Authenticate and obtain an access token to use other API endpoints. POST api/auth/login

Messages

• Send Message: POST /messages/send

Authentication

All API requests require a valid API token. Include the token in the header:

Authorization: <your_token>

Data Format

The API supports JSON for both request and response formats. Ensure your requests include:

Content-Type: application/json

Error Handling

The API uses standard HTTP status codes to indicate success or failure:

• 200 OK: Successful request.

• 400 Bad Request: Invalid request parameters.

• 401 Unauthorized: Authentication failure.

• 500 Internal Server Error: Server-side issue.

For detailed documentation, including example requests and responses, refer to the full API documentation.