Knowledge Base Website Changelog Book a Demo Login

Highlights

APIs for adding highlights on accounts.

PreviousActivites NextContacts

Last updated 8 hours 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

application/json

objectOptional

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

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

application/json

objectOptional

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

application/json

objectOptional

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