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", "settings": { "additionalProperty": "example" }, "auto_create_leads_from_whatsapp": true, "auto_invoice_on_accept": true, "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" } }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

name

string

>= 1 characters <= 200 characters

timezone

string

<= 50 characters

currency

string

>= 3 characters <= 3 characters

settings

object

key

additional properties

auto_create_leads_from_whatsapp

boolean

auto_invoice_on_accept

boolean

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

Responses

200

OK

400

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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}