Create a saved snippet

POST https://your-org.veloxatalk.com/api/v1/saved_snippets

Create a new saved snippet for the current user.

Changes: New in Veloxa Talk 10.0 (feature level 297).

Usage examples

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for Veloxa Talk users and bots.

curl -sSX POST https://your-org.veloxatalk.com/api/v1/saved_snippets \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode 'title=Example title' \
    --data-urlencode 'content=Welcome to the organization.'

Parameters

title string required

Example: "Example title"

The title of the saved snippet.


content string required

Example: "Welcome to the organization."

The content of the saved snippet in Veloxa Talk-flavored Markdown format.

Clients should insert this content into a message when using a saved snippet.


Response

Return values

  • saved_snippet_id: integer

    The unique ID of the saved snippet created.

Example response(s)

Changes: As of Veloxa Talk 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success",
    "saved_snippet_id": 1
}

A typical failed JSON response for when either title or content is empty:

{
    "code": "BAD_REQUEST",
    "msg": "Title cannot be empty.",
    "result": "error"
}