Skip to content
Pitch2SaleDevelopers
Open the app
Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.

PUT /calendar/routing-rule

PUT
/api/v1/calendar/routing-rule
curl --request PUT \
--url https://api.pitch2sale.com/api/v1/calendar/routing-rule \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "strategy": "round_robin", "rep_pool": [ { "user_id": "example", "is_active": true, "daily_capacity": 1, "specialties": [ "example" ], "weight": 1 } ], "fallback_user_id": "example", "fallback_to_human_email": true }'
Media typeapplication/json
object
strategy
required
string
Allowed values: round_robin weighted skill_based
rep_pool
required
Array<object>
<= 50 items
object
user_id
required
string
/^[0-9a-fA-F]{24}$/
is_active
required
boolean
daily_capacity
required
integer
specialties
required
Array<string>
<= 20 items
weight
required
number
<= 10
fallback_user_id
required
Any of:
string
/^[0-9a-fA-F]{24}$/
fallback_to_human_email
required
boolean

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

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