PUT /settings/portal

PUT

/api/v1/settings/portal

curl --request PUT \
  --url https://api.pitch2sale.com/api/v1/settings/portal \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "is_enabled": true, "welcome_message": "example", "branding": { "logo_url": "https://example.com", "primary_color": "example", "accent_color": "example" }, "feature_toggles": { "knowledge_base": true, "profile": true, "files": true } }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

is_enabled

boolean

welcome_message

Any of:

string

string

<= 1000 characters

null

null

branding

object

logo_url

Any of:

string

string format: uri

<= 2048 characters

null

null

primary_color

Any of:

string

string

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

null

null

accent_color

Any of:

string

string

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

null

null

feature_toggles

object

knowledge_base

boolean

profile

boolean

files

boolean

Example^generated

{
  "is_enabled": true,
  "welcome_message": "example",
  "branding": {
    "logo_url": "https://example.com",
    "primary_color": "example",
    "accent_color": "example"
  },
  "feature_toggles": {
    "knowledge_base": true,
    "profile": true,
    "files": true
  }
}

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

402

Feature not available on the organization plan

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