Skip to content
Developers
Get started
Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.

PATCH /mira

PATCH
/api/v1/mira
curl --request PATCH \
--url https://api.pitch2sale.com/api/v1/mira \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "company_name": "example", "business_summary": "example", "allowed_origins": [ "example" ], "booking_page_id": "example", "privacy_url": "https://example.com", "handoff_email": "hello@example.com", "disclosure_mode": "always", "ai_notice_text": "example", "show_badge": true, "settings": { "agent_name": "example", "tone": "warm", "additional_instructions": "example", "greeting_en": "example", "greeting_hi": "example", "disclosure": "example", "button_label": "example", "hero_hint": "example", "busy_message": "example", "voice_en": "Zephyr", "voice_hi": "Zephyr", "placement_mode": "home_hero", "include_paths": [ "example" ], "exclude_paths": [ "example" ], "timezone": "example", "business_hours": { "days": [ 1 ], "start": "example", "end": "example" }, "off_hours_action": "callback", "transcript_retention_days": 1, "no_lead_retention_days": 1, "chat_enabled": true, "chat_include_paths": [ "example" ], "chat_exclude_paths": [ "example" ], "chat_launcher_label": "example", "chat_greeting": "example", "chat_suggestions": [ "example" ], "launcher_disclosure": "example" } }'
Media typeapplication/json
object
company_name
string
>= 1 characters <= 80 characters /^\P{Cc}*$/
business_summary
string
<= 2000 characters
allowed_origins
Array<string>
<= 10 items
booking_page_id
Any of:
string
/^[a-f0-9]{24}$/
privacy_url
Any of:
string format: uri
<= 500 characters
handoff_email
Any of:
string format: email
<= 254 characters
disclosure_mode
string
Allowed values: always where_required
ai_notice_text
/^\P{Cc}*$/
/\bAI\b/
show_badge
boolean
settings
object
agent_name
string
>= 1 characters <= 40 characters /^\P{Cc}*$/
tone
string
Allowed values: warm crisp playful
additional_instructions
string
<= 1500 characters
greeting_en
string
>= 20 characters <= 160 characters
greeting_hi
string
>= 20 characters <= 160 characters
disclosure
string
>= 30 characters <= 200 characters
button_label
string
>= 2 characters <= 32 characters
hero_hint
string
>= 10 characters <= 120 characters
busy_message
string
>= 10 characters <= 120 characters
voice_en
string
Allowed values: Zephyr Puck Charon Kore Fenrir Leda Orus Aoede Callirrhoe Autonoe Enceladus Iapetus Umbriel Algieba Despina Erinome Algenib Rasalgethi Laomedeia Achernar Alnilam Schedar Gacrux Pulcherrima Achird Zubenelgenubi Vindemiatrix Sadachbia Sadaltager Sulafat
voice_hi
string
Allowed values: Zephyr Puck Charon Kore Fenrir Leda Orus Aoede Callirrhoe Autonoe Enceladus Iapetus Umbriel Algieba Despina Erinome Algenib Rasalgethi Laomedeia Achernar Alnilam Schedar Gacrux Pulcherrima Achird Zubenelgenubi Vindemiatrix Sadachbia Sadaltager Sulafat
placement_mode
string
Allowed values: home_hero selected all
include_paths
Array<string>
<= 50 items
exclude_paths
Array<string>
<= 50 items
timezone
string
>= 1 characters <= 64 characters
business_hours
object
days
required
Array<integer>
<= 7 items
start
required
string
/^([01]\d|2[0-3]):[0-5]\d$/
end
required
string
/^([01]\d|2[0-3]):[0-5]\d$/
off_hours_action
string
Allowed values: callback link both
transcript_retention_days
integer
>= 7 <= 365
no_lead_retention_days
integer
>= 7 <= 365
chat_enabled
boolean
chat_include_paths
Array<string>
<= 50 items
chat_exclude_paths
Array<string>
<= 50 items
chat_launcher_label
string
>= 2 characters <= 24 characters
chat_greeting
string
>= 20 characters <= 300 characters
chat_suggestions
Array<string>
<= 6 items
launcher_disclosure
string
>= 30 characters <= 240 characters

OK

Validation failed

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}

Authentication required or token invalid

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}

Feature not available on the organization plan

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}

Role permission or token scope missing; OAuth app tokens are not accepted on this route

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}

Rate limit exceeded

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}