Skip to main content
PUT
Update a snippet

Authorizations

x-conveyour-token
string
header
required

Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.

Path Parameters

id
string
required

The id identifier.

Query Parameters

teams[]
string[]

Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.

Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.

Body

application/json
name
string

Updated name for the snippet.

shortcut
string

Updated shortcut key.

content
string

Updated snippet content. Supports Liquid syntax.

text_content
string

Plain-text version of the content.

notes
string

Internal notes.

files
string[]

Updated file attachments.

folder_id
string

Move snippet to a different folder.

order
integer

Sort order within the folder.

Response

Success.

The common response envelope shared by all ConveYour endpoints.

status
enum<string>

ok on success, failed on error.

Available options:
ok,
failed
message
string

Human-readable description of the result.

data
object

A snippet. Create, update and the HTML update return this directly, so it carries NO editable / deletable flags — those are computed per user by the read endpoints only.