Add an instruction on an item

post

https://api.seismic.com/integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/instructions

Adds an instruction to a library content item identified by libraryContentId within the specified teamsite. Instructions are rich-text annotations attached to content items that provide guidance to users when they view or share the item. The instruction type must be text. The text field supports a limited set of HTML syntax including bold, italic, underline, strikethrough, ordered and unordered lists, hyperlinks, and heading elements. On success the created instruction is returned with its generated id. Requires the seismic.library.manage scope.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

teamsiteId

string

required

Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as 1.

libraryContentId

string

required

Identifier of the library content item targeted by the operation.

Body Params

JSON object describing the instruction to create on the content item.

Request payload used to create a new instruction on a library content item.

type

string

enum

The type of instruction to create. Currently the only supported value is text, indicating a free-text instruction with limited HTML formatting.

Allowed:

title

string

length between 1 and 255

The title of the instruction displayed to users. Used as the heading shown to readers in the Library UI and in downstream rendering surfaces.

text

string

length between 1 and 4000

The rich-text body of the instruction. Supports a limited set of HTML tags including bold, italic, underline, strikethrough, ordered and unordered lists, hyperlinks, and heading elements.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created. The instruction was created successfully and the full instruction object is returned.

400Bad Request. The teamsiteId or libraryContentId is malformed, or the request body is invalid

401Unauthorized. The request is missing a bearer token, or the token is invalid or expired.

403Forbidden. The caller is authenticated but does not have the seismic.library.manage scope required to add instructions.

404Not Found. The targeted teamsite, folder, file, item, or workflow could not be located by the provided identifier.

500Internal Server Error. An unexpected server-side error occurred while processing the request.

504Gateway Timeout. The upstream service did not respond in time, or is temporarily unavailable. Safe to retry after a brief delay.