Highlights
APIs for adding highlights on accounts.
The {account_id} parameter accepts either:
Internal account ID (UUID format)
External ID (any string format)
The ID or external ID of the account that the highlight belongs to.
The HTML content for this highlight.
Optional RFC3339 timestamp of when this highlight will expire.
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"
}The {account_id} parameter accepts either:
Internal account ID (UUID format)
External ID (any string format)
The ID of the highlight to update.
The ID or external ID of the account that the highlight belongs to.
The updated HTML content for this highlight.
The updated expires at timestamp (RFC3339).
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"
}The {account_id} parameter accepts either:
Internal account ID (UUID format)
External ID (any string format)
The ID or external ID of the account that the highlight belongs to.
The ID of the highlight to delete.
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"
}Last updated
Was this helpful?