Skip to main content
POST
Create a snippet

Authorizations

x-conveyour-token
string
header
required

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

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
required

Human-readable name for the snippet.

shortcut
string
required

The key used to reference this snippet in templates: snippet(legal.sms_footer). Use dot notation to namespace snippets (e.g. legal.sms_footer, program.intro).

content
string
required

The snippet content. Supports Liquid syntax.

text_content
string

Plain-text version of the content (used when the rich version is HTML).

notes
string

Internal notes about the snippet (not sent to contacts).

files
string[]

Array of file objects to attach to the snippet.

folder_id
string

ID of the folder to place this snippet in.

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.