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.

Update the organization's profile and settings

PUT
/api/v1/org
curl --request PUT \
--url https://api.pitch2sale.com/api/v1/org \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "timezone": "example", "currency": "example", "country": "example", "call_recording_retention_days": 30, "settings": { "additionalProperty": "example" }, "auto_create_leads_from_whatsapp": true, "auto_invoice_on_accept": true, "subscription_invoice_status": "draft", "auto_contract_on_proposal_accept": true, "auto_project_on_contract_sign": true, "message_visibility_policy": "role_based", "support_email_aliases": [ "hello@example.com" ], "compliance_settings": { "sms_opt_out_suffix": "example", "require_dnc_check": true }, "security_settings": { "mfa_policy": "off" } }'
Media typeapplication/json
object
name
string
>= 1 characters <= 200 characters
timezone
string
<= 50 characters
currency
string
>= 3 characters <= 3 characters
country
Any of:
string
string
/^[A-Z]{2}$/
call_recording_retention_days
Any of:
number
Allowed values: 30 90 180 365 730
settings
object
key
additional properties
auto_create_leads_from_whatsapp
boolean
auto_invoice_on_accept
boolean
subscription_invoice_status
string
Allowed values: draft sent
auto_contract_on_proposal_accept
boolean
auto_project_on_contract_sign
boolean
message_visibility_policy
string
Allowed values: role_based strict_own
support_email_aliases
Array<string>
<= 25 items
compliance_settings
object
sms_opt_out_suffix
string
<= 80 characters
require_dnc_check
boolean
security_settings
object
mfa_policy
string
Allowed values: off admins all

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