Highlights
9 routes. Paths are relative to https://api.intersink.com/v1.
- GET/highlightsGet all highlights with optional filters
- POST/highlightsCreate a new highlight group
- PATCH/highlights/{id}Update highlight details
- DELETE/highlights/{id}Delete a highlight group
- GET/highlights/{id}/mediaGet all media items inside a highlight
- POST/highlights/{id}/mediaAdd a media/story to a highlight
- PATCH/highlights/media/{mediaId}Update media item inside a highlight
- DELETE/highlights/media/{mediaId}Remove a media item from highlight
- GET/highlights/user/{profileId}Get all highlights for a user profile
Get all highlights with optional filters
GET/highlights
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| sortrequired | string, query | |
| limitrequired | string, query | |
| pagerequired | string, query |
Response
200. data is object[].
Create a new highlight group
POST/highlights
Needs a signed-in user (Bearer token or access_token cookie).
Request body application/json
| Field | Type | Description |
|---|---|---|
| titlerequired | string | Title of the highlight At most 255 characters. Example: "Travel 2026" |
| description | string | Example: "My recent trip to Manali" |
| active_profile_id | string | Example: "Optional Profile ID if creating for business profile" |
| sort | string | |
| status | string | One of: "draft", "published", "archived". |
Response
201. The payload in data is of type object.
Update highlight details
PATCH/highlights/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| title | string | At most 255 characters. |
| description | string | |
| status | string | One of: "draft", "published", "archived". Example: "published" |
| sort | object | Example: 1 |
Response
200. The payload in data is of type object.
Delete a highlight group
DELETE/highlights/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Get all media items inside a highlight
GET/highlights/{id}/media
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. data is object[].
Add a media/story to a highlight
POST/highlights/{id}/media
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| story_id | number | ID of an existing story to add to highlight |
| file_id | number | Or an existing image from your drive (file row id) Minimum 1. |
| active_profile_id | string | Example: "Optional Profile ID if adding for business profile" |
| title | string | At most 255 characters. |
| description | string | |
| url | string | At most 255 characters. |
| sort | string | |
| status | string | One of: "draft", "published", "archived". |
Response
201. The payload in data is of type object.
Update media item inside a highlight
PATCH/highlights/media/{mediaId}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| mediaIdrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| title | string | At most 255 characters. |
| description | string | |
| url | string | At most 255 characters. |
| status | string | One of: "draft", "published", "archived". |
| sort | object |
Response
200. The payload in data is of type object.
Remove a media item from highlight
DELETE/highlights/media/{mediaId}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| mediaIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Get all highlights for a user profile
GET/highlights/user/{profileId}
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| profileIdrequired | string, path | |
| statusrequired | string, query | |
| sortrequired | string, query | |
| limitrequired | string, query | |
| pagerequired | string, query |
Response
200. data is object[].