snippets

Update snippet

Update one of your own snippets.

patch/v1/snippets/{id}

Request

  • Base URL: https://api.botdog.co
  • URL: https://api.botdog.co/v1/snippets/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Request body

namestring

The snippet name

contentstring

Template body (for TEXT snippets)

promptstring

Generation prompt (for LLM snippets)

shortcutstring

A quick-access shortcut (must be unique)

status'ACTIVE' | 'ARCHIVED'

Set ACTIVE or ARCHIVED

Response

idstring required

The unique identifier of the snippet

namestring required

The name of the snippet

shortcutstring nullable

The keyboard shortcut for the snippet, if any

typestring required

The snippet type: a static TEXT template or an LLM prompt

statusstring required

The snippet status

contentstring nullable

The template body (for TEXT snippets)

promptstring nullable

The generation prompt (for LLM snippets)

isSharedboolean required

Whether the snippet is shared with the team

createdAtstring date-time required

When the snippet was created

updatedAtstring date-time required

When the snippet was last updated

Example response

{
  "type": "TEXT",
  "status": "ACTIVE"
}

Changes

No recorded changes to this operation across all 1 revision of this API.