The Clip Object
Overview of API clip properties: dates, IDs, content, and mutable/immutable fields
Clips returned by the API look a little like this:
{
// Dates
"created_at": ISODate("2016-06-26T15:30:38.731Z"),
// Identifiers
"clip_id": "test_clip_id"
"user_id": "test_user_id",
// Mutable Properties
"title": "Logging In To Your HelpDocs",
"content": "<p>To improve the experience for your end users...</p>",
// Calculated Properties
"is_private": false,
"is_locked": true
}Some fields are mutable (you can edit them) and some are immutable (we update them for you).
Property | |
created_at Date | When article was first created. |
clip_id String | A unique identifier for the Clip |
user_id String | The user_id of the user the Clip belongs to. If you create your Clip through the API this will be empty. |
title String | The title of the Clip. Plaintext only, and keep it short. |
content String | The body of the Clip. This should be provided as an HTML string. |
is_private Boolean | Private articles aren't visible to other users. It's not possible to set this option through the API. |
is_locked Boolean | Locked articles cannot be edited by others. It's not possible to set this option through the API. |
How did we do?
Getting a Single Clip
Updating a Clip
