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
    • Connect to AI Agent
      POST
  • whatsapp_templates
    • List all templates
      GET
    • Create a template
      POST
    • Update template
      PATCH
    • Archive template
      PATCH
    • Pause template
      PATCH
    • Submit template
      PATCH
  • conversations
    • Agent Assignment
      POST
    • Close Conversation
      POST
  • contacts
    • Create a contact
      POST
    • Create a multiple contacts
      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 multiple contacts

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
metadata
object 
optional
Example:
{"key":"value"}
key
string 
required
Example
[
    {
        "name": "Alfred Hitchcock",
        "email": "alfred@example.com",
        "phone_number": "+19019019191 or +919876543210",
        "metadata": {
            "source": "website",
            "location": "bangalore"
        }
    },
    {
        "name": "Stanley Kubrick",
        "email": "stanley@example.com",
        "phone_number": "+14155552671 or +919876543211",
        "metadata": {
            "source": "referral",
            "location": "mumbai"
        }
    },
    {
        "name": "Akira Kurosawa",
        "email": "akira@example.com",
        "phone_number": "+81345678901 or +919876543212",
        "metadata": {
            "source": "website",
            "location": "delhi"
        }
    },
    {
        "name": "Satyajit Ray",
        "email": "satyajit@example.com",
        "phone_number": "+913324176666 or +919876543213",
        "metadata": {
            "source": "app",
            "location": "kolkata"
        }
    },
    {
        "name": "Ingmar Bergman",
        "email": "ingmar@example.com",
        "phone_number": "+46812345678 or +919876543214",
        "metadata": {
            "source": "referral",
            "location": "chennai"
        }
    }
]

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",
        "metadata": {
            "source": "website",
            "location": "bangalore"
        }
    },
    {
        "name": "Stanley Kubrick",
        "email": "stanley@example.com",
        "phone_number": "+14155552671 or +919876543211",
        "metadata": {
            "source": "referral",
            "location": "mumbai"
        }
    },
    {
        "name": "Akira Kurosawa",
        "email": "akira@example.com",
        "phone_number": "+81345678901 or +919876543212",
        "metadata": {
            "source": "website",
            "location": "delhi"
        }
    },
    {
        "name": "Satyajit Ray",
        "email": "satyajit@example.com",
        "phone_number": "+913324176666 or +919876543213",
        "metadata": {
            "source": "app",
            "location": "kolkata"
        }
    },
    {
        "name": "Ingmar Bergman",
        "email": "ingmar@example.com",
        "phone_number": "+46812345678 or +919876543214",
        "metadata": {
            "source": "referral",
            "location": "chennai"
        }
    }
]'

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
metadata
object 
optional
Example:
{"key":"value"}
key
string 
required
Example
{
    "name": "Alfred Hitchcock",
    "email": "alfred@example.com",
    "phone_number": "+19019019191 or +919876543210",
    "metadata": {
        "key": "value"
    }
}
🟠422Parameter Error
Modified at 2025-07-03 05:20:13
Previous
Create a contact
Next
Create an order
Built with