Pylon
Knowledge BaseWebsiteChangelogBook a DemoLogin
  • Getting Started
    • Introduction
    • Quick Start
    • Slack Setup
    • Channel Configuration
    • User Guide
  • Support Workflows
    • Omnichannel Support
    • Issues
      • Views
      • Statuses
      • Message Editor
      • Copilot
      • Internal Threads
      • Proactive Issues
      • Translation
      • Bulk actions
      • Issue Groups
    • SLAs
    • Support Hours
    • CSAT
    • Ticket Forms
    • Assignment Rules
      • User Status
    • Email
  • Platform
    • Custom Fields
    • Required and Conditional Fields
    • Tags
    • Teams
    • Triggers
      • Logs & History
    • Macros
    • Command Search
    • Roles & User Management
    • Training Data
    • Ask AI
  • AI Agents
    • Overview
    • Build
      • Resources
    • Test
  • Knowledge Base
    • Overview
    • Articles & Collections
      • Editor
      • Copilot
      • Templates
      • Collaboration
    • Knowledge Gaps
    • Styling & Customization
    • Custom Authentication
    • Search
    • Translation
  • Customer Portal
    • Overview
    • Styling & Customization
    • Access Control
    • Portal Experience
    • Custom Authentication
  • In-App Chat
    • Overview
    • Styling
    • Functionality
    • Chat Experience
    • Chat Setup
    • Identity Verification
    • JavaScript API
  • Account Management
    • Accounts
    • Views
    • Notebooks
      • Blocks
    • Highlights
    • Fields
    • Copilot
    • Activities
      • Custom Activities
  • Reporting & Analytics
    • Analytics
    • Default Dashboards
    • Custom Dashboards
  • Broadcasts
    • Overview
    • Create a Broadcast
    • Analytics
  • Integrations
    • CRM
      • Salesforce
      • Hubspot
      • Attio
      • Pipedrive
    • Ticketing
      • Linear
      • GitHub Issues
      • Asana
      • Jira
    • Alerting
      • PagerDuty
      • Opsgenie
    • Chat
      • Slack
        • Internal Threads
        • Collect Data
        • Support Ticket Flow
        • Welcome Message
        • Bookmarks
        • Onboard Employees
        • Left Company
        • Slack Community
      • Microsoft Teams
      • Discord
    • Incident Management
      • incident.io
    • Call Recording
      • Gong
      • Fathom
      • Grain
      • Fireflies
  • Data Warehouse
    • Snowflake
    • BigQuery
  • Developer
    • API
      • Authentication
      • Errors
      • API reference
        • Attachments
        • Accounts
          • Activities
          • Highlights
        • Contacts
        • Custom Fields
        • Issues
        • Knowledge Base
        • Me
        • Messages
        • Tags
        • Teams
        • Ticket Forms
        • User roles
        • Users
      • External IDs
    • Custom Apps
    • Embedded Iframes
    • Webhooks
Powered by GitBook
On this page

Was this helpful?

  1. Developer
  2. API
  3. API reference
  4. Accounts

Highlights

APIs for adding highlights on accounts.

PreviousActivitiesNextContacts

Last updated 21 days ago

Was this helpful?

Deletes an account highlight.

delete
Authorizations
Path parameters
account_idstringRequired

The ID of the account that the highlight belongs to.

highlight_idstringRequired

The ID of the highlight to delete.

Responses
200Success
application/json
400Error
application/json
404Error
application/json
500Error
application/json
delete
DELETE /accounts/{account_id}/highlights/{highlight_id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer JWT
Accept: */*
{
  "data": {
    "success": true
  },
  "request_id": "text"
}
  • POSTCreates a new account highlight.
  • PATCHUpdates an account highlight.
  • DELETEDeletes an account highlight.

Creates a new account highlight.

post
Authorizations
Path parameters
account_idstringRequired

The ID of the account that the highlight belongs to.

Body
content_htmlstringRequired

The HTML content for this highlight.

expires_atstringOptional

Optional RFC3339 timestamp of when this highlight will expire.

Responses
200Success
application/json
400Error
application/json
404Error
application/json
500Error
application/json
post
POST /accounts/{account_id}/highlights HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "content_html": "text",
  "expires_at": "text"
}
{
  "data": {
    "account_id": "text",
    "content_html": "text",
    "created_at": "text",
    "expires_at": "text",
    "id": "text",
    "updated_at": "text"
  },
  "request_id": "text"
}

Updates an account highlight.

patch
Authorizations
Path parameters
highlight_idstringRequired

The ID of the highlight to update.

account_idstringRequired

The ID of the account that the highlight belongs to.

Body
content_htmlstringOptional

The updated HTML content for this highlight.

expires_atstringOptional

The updated expires at timestamp (RFC3339).

Responses
200Success
application/json
400Error
application/json
404Error
application/json
500Error
application/json
patch
PATCH /accounts/{account_id}/highlights/{highlight_id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "content_html": "text",
  "expires_at": "text"
}
{
  "data": {
    "account_id": "text",
    "content_html": "text",
    "created_at": "text",
    "expires_at": "text",
    "id": "text",
    "updated_at": "text"
  },
  "request_id": "text"
}