Update the organization's branding

PUT

/api/v1/org/branding

curl --request PUT \
  --url https://api.pitch2sale.com/api/v1/org/branding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "logo_url": "https://example.com", "company_name": "example", "company_address": "example", "company_phone": "example", "company_email": "hello@example.com", "company_website": "https://example.com", "tax_id": "example", "primary_color": "example", "accent_color": "example", "font_family": "sans-serif", "invoice_template": "classic", "footer_text": "example", "bank_detail": "example", "bank_details": [ { "_id": "example", "label": "", "content": "example", "is_default": false } ], "terms_and_conditions": "example", "digital_signature_url": "https://example.com" }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

logo_url

Any of:

string

string format: uri

<= 2048 characters

null

null

company_name

string

<= 200 characters

company_address

string

<= 1000 characters

company_phone

Any of:

string

string

<= 30 characters

null

null

company_email

Any of:

string

string format: email

<= 255 characters

null

null

company_website

Any of:

string

string format: uri

<= 500 characters

null

null

tax_id

Any of:

string

string

<= 50 characters

null

null

primary_color

string

/^#[0-9a-fA-F]{6}$/

accent_color

string

/^#[0-9a-fA-F]{6}$/

font_family

string

Allowed values: sans-serif serif mono

invoice_template

string

Allowed values: classic modern minimal professional creative bold elegant compact split branded orange

footer_text

Any of:

string

string

<= 5000 characters

null

null

bank_detail

Any of:

string

string

<= 2000 characters

null

null

bank_details

Array<object>

<= 20 items

object

_id

string

label

string

"" <= 120 characters

content

required

string

<= 2000 characters

is_default

boolean

terms_and_conditions

Any of:

string

string

<= 10000 characters

null

null

digital_signature_url

Any of:

string

string format: uri

<= 2048 characters

null

null

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