Skip to content

Open-source live-chat, email support, omni-channel desk. An alternative to Intercom, Zendesk, Salesforce Service Cloud etc. πŸ”₯πŸ’¬

2.7 KB
Raw Blame
tags:
  - Help Center
operationId: update-portal-to-account
summary: Update a portal
description: Update a portal to account
security:
  - userBearerAuth: []
  - userApiKey: []
parameters:
  - $ref: '#/components/parameters/account_id'
  - $ref: '#/components/parameters/portal_slug'
requestBody:
  required: true
  content:
    application/json:
      schema:
        $ref: '#/components/schemas/portal_create_update_payload'
responses:
  '200':
    description: Success
    content:
      application/json:
        schema:
          $ref: '#/components/schemas/portal_single'
        example:
          payload:
            id: 123
            archived: false
            color: "#1F93FF"
            config:
              allowed_locales:
                - code: "en"
                  articles_count: 32
                  categories_count: 9
            custom_domain: "chatwoot.help"
            header_text: "Handbook"
            homepage_link: "https://www.chatwoot.com"
            name: "Handbook"
            slug: "handbook"
            page_title: "Handbook"
            account_id: 123
            inbox:
              id: 123
              name: "Chatwoot"
              website_url: "chatwoot.com"
              channel_type: "Channel::WebWidget"
              avatar_url: "https://example.com/avatar.png"
              widget_color: "#1F93FF"
              website_token: "4cWzuf9i9jxN9tbnv8K9STKU"
              enable_auto_assignment: true
              web_widget_script: "<script>...</script>"
              welcome_title: "Hi there ! πŸ™ŒπŸΌ"
              welcome_tagline: "We make it simple to connect with us."
              greeting_enabled: true
              greeting_message: "Hey there πŸ‘‹, Thank you for reaching out to us."
              channel_id: 123
              working_hours_enabled: true
              enable_email_collect: true
              csat_survey_enabled: true
              timezone: "America/Los_Angeles"
              business_name: "Chatwoot"
              hmac_mandatory: true
            logo:
              id: 123
              portal_id: 123
              file_type: "image/png"
              account_id: 123
              file_url: "https://example.com/logo.png"
              blob_id: 123
              filename: "square.png"
            meta:
              all_articles_count: 32
              categories_count: 9
              default_locale: "en"
  '403':
    description: Access denied
    content:
      application/json:
        schema:
          $ref: '#/components/schemas/bad_request_error'
  '404':
    description: Portal not found
    content:
      application/json:
        schema:
          $ref: '#/components/schemas/bad_request_error'