1
OAS 3.0.2

Peach APIs for WhatsApp Business

Client Libraries
Shell
Ruby
Node.js
PHP
Python
C
More
Authentication
API Key (api_key)

messaging

Send a transactional message

Body
application/json
template_name
string
Exampleorder_confirmation
to
object
arguments
object
Responses
  • 201
  • 422
POST/transactional_messages
Shell cURL
{
  "template_name": "order_confirmation",
  "to": {
    "name": "Alfred Hitchcock",
    "email": "alfred@example.com",
    "phone_number": "+19019019191 or +919876543210"
  },
  "arguments": {
    "key": "product_title or product_price",
    "value": null
  }
}

orders

contacts

Create a contact on Peach

Body
application/json
name
string
ExampleAlfred Hitchcock
email
string
Examplealfred@example.com
phone_number
required
string
Example+19019019191 or +919876543210
Responses
  • 201
  • 422
POST/subscribers
Shell cURL
{
  "name": "Alfred Hitchcock",
  "email": "alfred@example.com",
  "phone_number": "+19019019191 or +919876543210"
}