curl --request PUT \
--url https://{subdomain}.conveyour.com/api/snippets/html/{id} \
--header 'Content-Type: text/html' \
--header 'x-conveyour-token: <api-key>' \
--data '<string>'const options = {
method: 'PUT',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'text/html'},
body: '<string>'
};
fetch('https://{subdomain}.conveyour.com/api/snippets/html/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'PUT',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'text/html'},
body: '<string>'
};
fetch('https://{subdomain}.conveyour.com/api/snippets/html/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/snippets/html/{id}"
payload = "<string>"
headers = {
"x-conveyour-token": "<api-key>",
"Content-Type": "text/html"
}
response = requests.put(url, data=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.conveyour.com/api/snippets/html/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => "<string>",
CURLOPT_HTTPHEADER => [
"Content-Type: text/html",
"x-conveyour-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"status": "ok",
"message": "success",
"data": {
"id": "64a1b2c3d4e5f6a7b8c9d0e1",
"name": "SMS Footer",
"shortcut": "legal.sms_footer",
"content": "<p>Reply <strong>STOP</strong> to opt out anytime.</p>"
}
}{
"status": "failed",
"message": "Token is either expired or does not have the correct permissions",
"data": []
}Update snippet HTML
Updates the raw HTML content of a snippet directly. Send the HTML as a plain text body — not JSON.
Update snippet HTML directly (raw body)
A missing record does not return 404. This handler reports the failure without a status code, and the error envelope defaults to HTTP 200 — you get 200 with status: "failed". Branch on status, not on the HTTP code.
curl --request PUT \
--url https://{subdomain}.conveyour.com/api/snippets/html/{id} \
--header 'Content-Type: text/html' \
--header 'x-conveyour-token: <api-key>' \
--data '<string>'const options = {
method: 'PUT',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'text/html'},
body: '<string>'
};
fetch('https://{subdomain}.conveyour.com/api/snippets/html/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'PUT',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'text/html'},
body: '<string>'
};
fetch('https://{subdomain}.conveyour.com/api/snippets/html/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/snippets/html/{id}"
payload = "<string>"
headers = {
"x-conveyour-token": "<api-key>",
"Content-Type": "text/html"
}
response = requests.put(url, data=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.conveyour.com/api/snippets/html/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => "<string>",
CURLOPT_HTTPHEADER => [
"Content-Type: text/html",
"x-conveyour-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"status": "ok",
"message": "success",
"data": {
"id": "64a1b2c3d4e5f6a7b8c9d0e1",
"name": "SMS Footer",
"shortcut": "legal.sms_footer",
"content": "<p>Reply <strong>STOP</strong> to opt out anytime.</p>"
}
}{
"status": "failed",
"message": "Token is either expired or does not have the correct permissions",
"data": []
}Authorizations
Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.
Path Parameters
The id identifier.
Query Parameters
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
The raw request body is used as the snippet content — this endpoint does NOT parse JSON. Any
Response
Success.
The common response envelope shared by all ConveYour endpoints.
ok on success, failed on error.
ok, failed Human-readable description of the result.
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.
Show child attributes
Show child attributes