RevReply

create-agent

POST

/agent

Request

Header Params

Authorization

string

required

Example:

Bearer {{api_key}}

string

required

Example:

application/json

Body Params multipart/form-data

agent_name

string

required

Responder title

Example:

Furniture Salesman

first_name

string

required

Responder first name

Example:

Robert

last_name

string

required

Responder last name

Example:

Deniro

company

string

required

Company on behalf of which responder will be replying

Example:

Woodworks LLC

company_website

string

required

Example:

https://woodworks.com

generate_profile

string

optional

If set to 1, company_overview and context will be fetched from company_website

Example:

company_overview

string

required

Example:

Deals in home %26 office furniture

context

string

required

Example:

Sells chairs, sofas, tables and other office equipment at competitive rates

meeting_link

string

required

Example:

https://zoom.com/hrehman200

calendar_link

string

required

Example:

https://calendly.com/hrehman200/15min

concise_reply

string

required

If 1, Generate shorter replies

Example:

soft_no

string

required

Should we reply to soft_nos from prospects

Example:

soft_no_response

string

required

What soft-no-reply should be sent

Example:

If you change your mind, do send me a message.

tone

string

required

Response tone
0 = 'Professional'
1 = 'Laid Back'
2 = 'Formal'
3 = 'Informl'
4 = 'Enthusiastic'
5 = 'Reserved'
6 = 'Neutral'

Example:

followup_days1

string

required

If values greater than 0, a followup will be sent to prospect, if there is atleast 1 reply from him

Example:

followup_days2

string

required

Example:

followup_days3

string

required

Example:

agent_objective

string

required

1=Schedule Meeting, 2=Other

Example:

timezone

string

required

Responder timezone, used if agent_objective=1

Example:

America/New_York

office_hours_from

string

required

Office start time in 24 hour format, used if agent_objective=1

Example:

08:00

office_hours_to

string

required

Office end time in 24 hour format, used if agent_objective=1

Example:

17:00

exclude_weekends

string

required

Should weekends be excluded from suggested meeting times, used if agent_objective=1

Example:

objective

string

required

Goal of the agent, used if agent_objective=2

Example:

Promote my website signup link: https://woodworks.com/signup

calendly_access_token

string

required

Pass calendly token to be able to generate scheduling urls during response generation

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/agent' \
--header 'Authorization: Bearer {{api_key}}' \
--header 'Accept: application/json' \
--form 'agent_name="Furniture Salesman"' \
--form 'first_name="Robert"' \
--form 'last_name="Deniro"' \
--form 'company="Woodworks LLC"' \
--form 'company_website="https://woodworks.com"' \
--form 'company_overview="Deals in home %26 office furniture"' \
--form 'context="Sells chairs, sofas, tables and other office equipment at competitive rates"' \
--form 'meeting_link="https://zoom.com/hrehman200"' \
--form 'calendar_link="https://calendly.com/hrehman200/15min"' \
--form 'concise_reply="0"' \
--form 'soft_no="1"' \
--form 'soft_no_response="If you change your mind, do send me a message."' \
--form 'tone="3"' \
--form 'followup_days1="2"' \
--form 'followup_days2="5"' \
--form 'followup_days3="13"' \
--form 'agent_objective="2"' \
--form 'timezone="America/New_York"' \
--form 'office_hours_from="08:00"' \
--form 'office_hours_to="17:00"' \
--form 'exclude_weekends="1"' \
--form 'objective="Promote my website signup link: https://woodworks.com/signup"' \
--form 'calendly_access_token=""'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Modified at 2024-12-12 20:07:25

status

update-agent