Highlights

APIs for adding highlights on accounts.

Create an account highlight

post

Creates a new highlight on an account.

Rate limit: 10 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

account_idstringRequired

The ID or external ID of the account that the highlight belongs to.

Body

application/json

content_htmlstringRequired

The HTML content for this highlight.

expires_atstringOptional

Optional RFC3339 timestamp of when this highlight will expire.

Responses

200Success

application/json

request_idstringOptional

400Error

application/json

404Error

application/json

500Error

application/json

post

/accounts/{account_id}/highlights

HTTPcURLJavaScriptPython

POST /accounts/{account_id}/highlights HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
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"
}

Update an account highlight

patch

Updates an existing account highlight. Only provided fields are modified.

Rate limit: 20 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

highlight_idstringRequired

The ID of the highlight to update.

account_idstringRequired

The ID or external ID of the account that the highlight belongs to.

Body

application/json

content_htmlstringOptional

The updated HTML content for this highlight.

expires_atstringOptional

The updated expires at timestamp (RFC3339).

Responses

200Success

application/json

request_idstringOptional

400Error

application/json

404Error

application/json

500Error

application/json

patch

/accounts/{account_id}/highlights/{highlight_id}

HTTPcURLJavaScriptPython

PATCH /accounts/{account_id}/highlights/{highlight_id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
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"
}

Delete an account highlight

delete

Permanently deletes an account highlight by ID.

Rate limit: 20 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

account_idstringRequired

The ID or external 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

/accounts/{account_id}/highlights/{highlight_id}

HTTPcURLJavaScriptPython

DELETE /accounts/{account_id}/highlights/{highlight_id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "success": true
  },
  "request_id": "text"
}