Peach
  1. contacts
Peach
  • messaging
    • Send a pre-approved template message
      POST
    • Poll template message status
      GET
    • Launch a broadcast
      POST
    • Poll broadcast status
      GET
    • Poll template messages status
      GET
  • contacts
    • Create a contact on Peach
      POST
  • orders
    • Create an order
      POST
    • Find order by ID
      GET
    • Create a refund for an order
      POST
  • medias
    • List available medias
      GET
    • Add a media
      POST
    • Remove a media
      DELETE
  • webhooks
    • Order status webhooks
    • Flow execution status webhooks
    • Message delivery status webhooks
    • AI flow execution status webhooks
  1. contacts

Create a contact on Peach

POST
/subscribers
contacts
Create a contact

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Body Params application/json
name
string 
optional
Example:
Alfred Hitchcock
email
string 
optional
Example:
alfred@example.com
phone_number
string 
required
Example:
+19019019191 or +919876543210
Example
{
    "name": "Alfred Hitchcock",
    "email": "alfred@example.com",
    "phone_number": "+19019019191 or +919876543210"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/subscribers' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw '{
    "name": "Alfred Hitchcock",
    "email": "alfred@example.com",
    "phone_number": "+19019019191 or +919876543210"
}'

Responses

🟢201Created
application/json
Created a contact successfully
Body
name
string 
optional
Example:
Alfred Hitchcock
email
string 
optional
Example:
alfred@example.com
phone_number
string 
required
Example:
+19019019191 or +919876543210
Example
{
    "name": "Alfred Hitchcock",
    "email": "alfred@example.com",
    "phone_number": "+19019019191 or +919876543210"
}
🟠422Parameter Error
Previous
Poll template messages status
Next
Create an order
Built with