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.

Update ticket routing rule

PUT
/api/v1/ticket-routing-rules/{id}
curl --request PUT \
--url https://api.pitch2sale.com/api/v1/ticket-routing-rules/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "is_active": true, "priority": 1, "conditions": [ { "field": "subject", "operator": "contains", "value": "example" } ], "actions": { "assign_to_user_id": "example", "set_category_id": "example", "set_priority": "low" } }'
id
required
string
Media typeapplication/json
object
name
string
>= 1 characters <= 200 characters
is_active
boolean
priority
integer
>= -1000 <= 1000
conditions
Array<object>
<= 20 items
object
field
required
string
Allowed values: subject body from_email category
operator
required
string
Allowed values: contains matches eq
value
required
string
>= 1 characters <= 1000 characters
actions
object
assign_to_user_id
Any of:
string
/^[0-9a-fA-F]{24}$/
set_category_id
Any of:
string
/^[0-9a-fA-F]{24}$/
set_priority
Any of:
string
Allowed values: low normal high urgent

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