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 /follow-ups/settings

PUT
/api/v1/follow-ups/settings
curl --request PUT \
--url https://api.pitch2sale.com/api/v1/follow-ups/settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "thresholds": { "new": 1, "proposal_sent": 1, "other": 1 }, "working_days": [ 1 ], "default_channel": "email", "few_shots_enabled": true, "whatsapp_auto": { "enabled": true, "default_account_id": "example", "fallback_after_hours": 1, "qr_daily_cap": 1, "max_attempts": 1, "templates": { "lang": "example", "fallback": "example", "rep_ping": "example", "draft_body": "example", "opener": "example" } } }'
Media typeapplication/json
object
thresholds
object
new
required
integer
>= 1 <= 30
proposal_sent
required
integer
>= 1 <= 30
other
required
integer
>= 1 <= 30
working_days
Array<integer>
>= 1 items <= 7 items
default_channel
string
Allowed values: email whatsapp sms
few_shots_enabled
boolean
whatsapp_auto
object
enabled
boolean
default_account_id
Any of:
string
/^[a-f0-9]{24}$/
fallback_after_hours
integer
>= 1 <= 48
qr_daily_cap
integer
>= 1 <= 100
max_attempts
integer
>= 1 <= 5
templates
object
lang
string
>= 2 characters <= 15 characters
fallback
Any of:
string
>= 1 characters <= 512 characters
rep_ping
Any of:
string
>= 1 characters <= 512 characters
draft_body
Any of:
string
>= 1 characters <= 512 characters
opener
Any of:
string
>= 1 characters <= 512 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"
}
]
}

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