Peach

Agent Assignment

POST

/api/v1/events

Request

Authorization

Add parameter in header

Authorization

Example:

Authorization: ********************

Body Params application/json

event_type

enum<string>

required

Allowed value:

assign_agent

contact

object

required

name

string

required

phone_number

string

required

assign_agent

object

required

agent_email

string

required

open_chat_on_assignment

boolean

required

Example

{
    "event_type": "assign_agent",
    "open_chat_on_assignment": true,
    "contact": {
        "name": "Alfred Hitchcock",
        "phone_number": "+13309106536"
    },
    "agent": {
        "email": "agent@example.com"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v1/events' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw '{
    "event_type": "assign_agent",
    "open_chat_on_assignment": true,
    "contact": {
        "name": "Alfred Hitchcock",
        "phone_number": "+13309106536"
    },
    "agent": {
        "email": "agent@example.com"
    }
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Modified at 2025-06-10 04:44:36

Submit template

Close Conversation