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.

PUT /whatsapp/mira/settings

PUT
/api/v1/whatsapp/mira/settings
curl --request PUT \
--url https://api.pitch2sale.com/api/v1/whatsapp/mira/settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "mode": "off", "watched_account_ids": [ "example" ], "quiet_minutes": 1, "business_hours": { "days": [ 1 ], "start": "example", "end": "example", "timezone": "example" }, "handoff_keywords": [ "example" ], "notify": "owner_else_team", "auto_paused": true, "auto_daily_cap_per_contact": 1, "auto_daily_cap_org": 1, "takeover_hours": 1 }'
Media typeapplication/json
object
mode
string
Allowed values: off draft auto
watched_account_ids
Array<string>
<= 50 items
quiet_minutes
integer
<= 1440
business_hours
object
days
Array<integer>
<= 7 items
start
string
/^([01]\d|2[0-3]):[0-5]\d$/
end
string
/^([01]\d|2[0-3]):[0-5]\d$/
timezone
string
>= 1 characters <= 64 characters
handoff_keywords
Array<string>
<= 50 items
notify
string
Allowed values: owner_else_team inbox_team
auto_paused
boolean
auto_daily_cap_per_contact
integer
>= 1 <= 50
auto_daily_cap_org
integer
>= 1 <= 5000
takeover_hours
integer
>= 1 <= 168

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"
}
]
}