LogoLogo
Become a PartnerStatus Page
  • get started
    • Welcome to 360Dialog
    • Quickstarts
      • Register as a Meta Tech Provider
      • Add a WhatsApp Number
      • Set up Integrated Onboarding
      • Create a Message Template
      • Send a Message
      • (temp title) Getting started as a partner
    • Pricing & Billing
      • Payment Methods for BR: Pix & Boleto
      • Month Closing Invoice (MCI)
    • Get API Access
    • Tech Provider Program
      • Understanding the Meta Tech Provider Program
      • Becoming a Meta Tech Provider: A Step-by-Step Guide
  • MM Lite Beta Program
    • Onboarding
    • Sending Messages
    • Expected Errors & Programming Languages
    • MM Lite Sandbox Testing
      • Sending Messages using MM Lite Sandbox
      • Expected Erros & Programming Languages
  • Partner & Account Management
    • Solutions for Partners
      • Benefits for Partners
      • Partner Hub
      • WABA Management
    • Account Setup & Management
      • Prerequisites and best practices for account creation
      • Account Structure
      • Account Creation
  • Integrations & API Development
    • Webhook Events & Setup
      • Webhook Events (Partner & Messaging API)
      • Webhook Configuration & Management
    • Integration Best Practices
      • Architecture and Security
      • Best Practices for Designing Integrations
        • Design a Stable Webhook Receiving Endpoint
      • Sizing Your Environment Based on Expected Throughput
      • Design a Resilient Message Sending Service
      • Integrated Onboarding
        • Basic Integrated Onboarding
        • Custom Integrated Onboarding
        • Host Your Own Embedded Signup
      • API Key Authentication for the Partner API
  • API Reference
    • Messaging API
    • Messaging Health Status
    • Sandbox (Test API Key)
    • Differences Between Cloud API and On-Premise API for Partners
      • [will be deprecated] Messaging with On-Premise API
    • Partner API
  • WABA Management
    • Managing WABA Accounts
      • Using the Partner Hub to manage Clients and Channels
      • Using the Partner API to manage Clients and Channels
      • Partner Permission to Generate API Key
      • Checking Usage & Statistics
    • Phone Number & Hosting
      • Migrating a Phone Number
        • Migrate number from Meta or alternate BSP to 360Dialog
        • Migrate a phone number to a new WABA
        • Migrate a phone number to a new WABA to change messaging Currency
      • WhatsApp Coexistence
        • Coexistence Onboarding
        • Coexistence Webhooks
      • Hosting type Change (On-premise API to Cloud API)
    • WABA Profile & Compliance
      • Display Name Guidelines
      • WABA Profile Info
      • WABA Policy Enforcement
      • Business Account Verification
    • Partner change (between 360Dialog Partners)
    • WhatsApp Flows
    • Accelerated Onboarding
    • Business Account Verification
  • Messaging
    • Sending & Receiving Messages
      • Conversations
      • Receiving messages
      • Before sending a message
    • Message Types
      • Conversational Components
      • Checklist for Message Broadcasts and Campaigns
      • Text messages
      • Interactive messages
        • Single and Multi Product Messages
        • Location Request Messages
        • Address Messages (India and Singapore only)
      • Contacts & Location Messages
    • Template Messages
      • Template Library
      • Template Elements
      • Sending Template Messages
      • Authentication Templates
        • Zero-Tap Authentication Templates
        • One-Tap Autofill Authentication Templates
        • Copy Code Authentication Templates
      • Catalog Templates
      • Product Card Carousel Templates
      • Single-Product Message Templates
      • Coupon Code Templates
      • Limited-Time Offer Templates
      • Multi-Product Templates
    • Media Messages
      • Upload, retrieve or delete media
    • Messaging Health & Troubleshooting
      • Messaging Limits & Quality Rating
      • Errors While Messaging
      • Messages statuses
  • Commerce & Payments
    • Payments (India Only)
      • Receive WhatsApp Payments via Payments Gateway
      • Receive WhatsApp Payments via Payment Links
      • Order Details Template Message
    • Payments (Singapore Only)
      • Receive WhatsApp Payments via Stripe
    • Products and Catalogs
      • India Businesses: Compliance for Commerce
  • Support & Updates
    • Help & Troubleshooting
      • FAQ
      • Error Code Reference
      • User Support Documentation
        • Tutorials
          • Page How to Troubleshoot Login Issues in the 360dialog Hub
          • How to Report an Issue
          • How to Contact Support
        • How-To Guides
          • Raise a support request
          • Requesting a Status Update for Business Verification
        • Reference
          • Troubleshooting Embedded Signup Issues
          • Commerce Policy Checks for WhatsApp API Access
          • Support Availability & SLAs
          • Incident Issue Prioritization
          • Case Types Table
        • Explanation
          • Why Business Verification Takes Time
          • Why Some Issues Are Not Emergencies
          • Understanding the Support Process
      • Support with Meta
    • Imprint & Data Privacy
    • Product Updates & News
      • How to ensure your Template Messages will be received
      • Integrated Onboarding new look and Campaigns Best Practices
Powered by GitBook
On this page
  • Partner ID
  • Login Credentials
  • Base URL
  • API Authentication Methods
  • Authentication
  • Partner Hub Webhook URL
  • Set Partner Hub Webhook URL
  • Get Partner Hub Webhook URL
  • Partner Hub Redirect URL
  • Set Redirect URL for your Partner Hub
  • Partner Hub Information
  • Get Partner Hub information

Was this helpful?

  1. API Reference

Partner API

Previous[will be deprecated] Messaging with On-Premise APINextManaging WABA Accounts

Last updated 21 days ago

Was this helpful?

The Partner API allows you to interact with our platform programatically.

This allows Partners to build a frictionless user journey for clients and automate processes.

In order to get started with the Partner API you need two things: your Partner ID and your Partner Hub long credentials.

Partner ID

The Partner ID is an unique ID that will be used for most API actions.

The easiest way to find your Partner ID is to log into the 360dialog Partner Hub on your browser and go to the "Partner Integration" section.

Login Credentials

All requests to the Partner API are secured by a Bearer Token, which can be obtained by providing a username (email) and a password. For this, you can either use a personal user account or set up a system user specifically for the API tasks. Make sure you have this information at hand when starting to work with the Partner API.

Base URL

The 360dialog Partner API allows to automate different processes of account management, usage statistics collection and let you know about status changing of your client’s accounts.

The default base URL for the 360dialog Partner API is https://hub.360dialog.io/api/v2

The basic principles of interaction with Partner API are the same as for Messaging API.

API Authentication Methods

Authentication

The Partner API supports two authentication methods: Bearer Token and API Key. While API Key authentication is the recommended approach, Bearer Tokens will remain valid for a transition period.

1. API Key Authentication (Recommended)

API Key authentication allows secure access to the Partner API without requiring user credentials. Each request must include a valid API key in the request headers.

How to Obtain an API Key

  • Navigate to the API Keys section in the Partner Dashboard

  • Generate an API key. Store the key securely, as it grants access to the Partner API. It will only be displayed once

Using the API key

Include the API Key in the request header:

x-api-key: YOUR_API_KEY

Example Request

curl -X GET "https://hub.360Dialog.io/api/v2/partners/<partner-id>" \
  -H "x-api-key: YOUR_API_KEY_HERE"

Best Practices for API Authentication

  • API Keys Usage: Use API Keys for service-to-service communication.

  • API Keys Rotation: Rotate keys periodically to maintain security.

  • Secure Storage: Always store API keys and credentials securely. Avoid exposing them publicly or hardcoding them in client-side code - use environment variables instead

  • Error Handling: Handle authentication errors gracefully. Common errors include:

    • 401 Unauthorized: Invalid or missing authentication credentials.

    • 403 Forbidden: Valid credentials, but insufficient permissions.

2. Bearer Token Authentication (Deprecated)

During the transition period, Bearer Token authentication will still be supported. To obtain a Bearer Token, provide your username (email) and password.

Request OAuth token for any Partner API request

POST https://hub.360dialog.io/api/v2/token

Request example

curl --request POST --url https://hub.360dialog.io/api/v2/token --header 'Authorization: ' --header 'Content-Type: application/json' --data '{ "username": "user@example.com", "password": "123StrongPass4Me!" }'

Request Body

Name
Type
Description

username*

string

Example: user@example.com

password*

string

Example: 123StrongPass4Me!

{
  "access_token": "string",   >> Token you should use for Authorization
  "refresh_token": "string",
  "token_type": "Bearer",
  "expires_in": 86400
}

After token is received, use this access token in your authorization header:

"Authorization": "Bearer <your-access-token>"

Bearer Tokens and Partner API Key (via X-API-KEY header) are authentication methods specifically designed to use with the Partner API. It cannot be used in combination with the Messaging API.

Partner Hub Webhook URL

A Webhook URL is required for you to receive webhook events about account signup and statuses..

Set Partner Hub Webhook URL

POST https://hub.360dialog.io/api/v2/partners/{partner_id}/webhook_url

Request example

curl --request POST --url https://hub.360dialog.io/api/v2/partners/partner_id/webhook_url --header 'Authorization: ' --header 'Content-Type: application/json' --data '{ "webhook_url": "https://example.com/webhook" }'

Path Parameters

Name
Type
Description

partner_id*

string

Your Partner Hub ID

Request Body

Name
Type
Description

webhook_url*

string

The Webhook URL you want to set

{
  "webhook_url": "string",
  "brand_name": null,
  "id": "string",
  "logo_url": null,
  "onboarding_deeplink_add_params": true,
  "payment_plan": {},
  "payment_required": true
}

You can check the Webhook URL configured with the endpoint below.

Get Partner Hub Webhook URL

GET https://hub.360dialog.io/api/v2/partners/{partner_id}/webhook_url

Request example

curl --request GET --url https://hub.360dialog.io/api/v2/partners/partner_id/webhook_url --header 'Authorization: ' --header 'Content-Type: application/json'

Path Parameters

Name
Type
Description

partner_id*

string

Your Partner Hub ID

{
  "webhook_url": "string"
}

Partner Hub Redirect URL

Set Redirect URL for your Partner Hub

PATCH https://hub.360dialog.io/api/v2/partners/{partner_id}

Request example

curl --request PATCH --url https://hub.360dialog.io/api/v2/partners/partner_id --header 'Authorization: ' --header 'Content-Type: application/json' --data '{ "webhook_url": "string", "partner_redirect_url": "string" }'

Path Parameters

Name
Type
Description

partner_id*

string

Your Partner Hub ID

Request Body

Name
Type
Description

webhook_url*

string

partner_redirect_url*

string

The Redirect URL you will use

{
  "webhook_url": "string",
  "partner_redirect_url": "string",
  "brand_name": null,
  "id": "string",
  "logo_url": null,
  "onboarding_deeplink_add_params": true,
  "payment_plan": {},
  "payment_required": true
}

Partner Hub Information

Use the GET request to check information regarding your 360dialog Partner Hub.

Get Partner Hub information

GET https://hub.360dialog.io/api/v2/partners/{partner_id}

Request example

curl --request GET --url https://hub.360dialog.io/api/v2/partners/partner_id --header 'Authorization: ' --header 'Content-Type: application/json'

Path Parameters

Name
Type
Description

partner_id*

string

{
    "allow_client_to_add_phone_no": true, 
    "billing_system": "string", //Indicates the type of partner payment
    "blocked_new_submission": false,
    "brand_name": "string", //Name currently set for this Partner Hub
    "country": "US",
    "id": "string", //Partner ID
    "logo_url": "string", //Logo currently set for this Partner Hub
    "onboarding_deeplink_add_params": false,
    "partner_redirect_url": "https://360dialog.com", //Redirect URL currently set for this Partner Hub
    "payment_plan": {},
    "payment_required": false,
    "settings": { //Tech Provider Information
        "account_sharing": {
            "business_manager_id": "string", 
            "solution_id": "string"
        },
        "default_data_localization_region": "DE", //Default data storage for this Partner Hub
        "partner_change_request": {
            "auto_approve": false 
        },
        "standard_tiered_pricing_enabled": true
    },
    "webhook_url": "string" //Webhook URL currently set for this Partner Hub
}

To understand more about the Partner ID and credentials, see the .

For more information on Authorization have a look at the and the .

For the Messaging API, the supported authentication method is through the use of D360-API Keys - Adding D360-API-KEY in the header with your Client's unique API Key as a value will grant access to Messaging API.

After the Webhook URL is set, you will start receiving events about the accounts registered under your Partner Hub.

The Redirect URL indicates where a client should be redirected to after they have completed the flow. Having a Redirect URL set is required to use Integrated Onboarding.

.

Your Webhook URL which needs to be previously created -

Architecture and Security documentation
See how to retrieve an API key here.
Integrated Onboarding
API description
token endpoint description
see how in the Partner API integration document
You can also add a Redirect URL in your Partner Hub
See all events available today in the Partner API here.