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.

Set per-user usage limits

PUT
/api/v1/usage/users/limits
curl --request PUT \
--url https://api.pitch2sale.com/api/v1/usage/users/limits \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "enabled": true, "apply_to_all": { "call_minutes": 1, "stt_minutes": 1, "sms_segments": 1, "translation_minutes": 1, "ai_tokens": 1 }, "users": [ { "user_id": "example", "limits": { "call_minutes": 1, "stt_minutes": 1, "sms_segments": 1, "translation_minutes": 1, "ai_tokens": 1 } } ] }'

Body: enabled (the switch), apply_to_all (one set of limits written to every active person; AI employees are skipped) and users ([{ user_id, limits }]). limits keys: call_minutes, stt_minutes, sms_segments, translation_minutes, ai_tokens; a whole number sets the limit, null removes it, a key left out is not changed. Any other meter, a user outside the organization or a meter the plan does not allow limits on is a 400 and nothing is saved. A person at their limit gets 402 USER_USAGE_LIMIT; they are notified at 80% and 100%, once per period each. Returns the same body as GET /usage/users. Requires settings.edit.

Media typeapplication/json
object
enabled
boolean
apply_to_all
object
call_minutes
Any of:
integer
<= 1000000000
stt_minutes
Any of:
integer
<= 1000000000
sms_segments
Any of:
integer
<= 1000000000
translation_minutes
Any of:
integer
<= 1000000000
ai_tokens
Any of:
integer
<= 1000000000
users
Array<object>
<= 500 items
object
user_id
required
string
/^[0-9a-fA-F]{24}$/
limits
required
object
call_minutes
Any of:
integer
<= 1000000000
stt_minutes
Any of:
integer
<= 1000000000
sms_segments
Any of:
integer
<= 1000000000
translation_minutes
Any of:
integer
<= 1000000000
ai_tokens
Any of:
integer
<= 1000000000
Examplegenerated
{
"enabled": true,
"apply_to_all": {
"call_minutes": 1,
"stt_minutes": 1,
"sms_segments": 1,
"translation_minutes": 1,
"ai_tokens": 1
},
"users": [
{
"user_id": "example",
"limits": {
"call_minutes": 1,
"stt_minutes": 1,
"sms_segments": 1,
"translation_minutes": 1,
"ai_tokens": 1
}
}
]
}

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