Typescript (SDK)
import { Crevio } from "@crevio/sdk";
const crevio = new Crevio({
apiKey: process.env["CREVIO_API_KEY"] ?? "",
});
async function run() {
const result = await crevio.forms.update({
id: "<id>",
formRequest: {},
});
console.log(result);
}
run();curl --request PATCH \
--url https://api.crevio.co/v1/forms/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"redirect_url": "<string>",
"delivery_url": "<string>",
"experience_id": "<string>",
"delivery_subject": "<string>",
"delivery_message": "<string>",
"archived_at": "2023-11-07T05:31:56Z",
"tag_ids": [
"<string>"
],
"form_fields_attributes": [
{
"name": "<string>",
"id": 123,
"required": true,
"position": 123,
"options": [
"<string>"
],
"_destroy": true
}
],
"settings": {},
"confirmation_required": true,
"delivery_file_id": "<string>"
}
'import requests
url = "https://api.crevio.co/v1/forms/{id}"
payload = {
"name": "<string>",
"redirect_url": "<string>",
"delivery_url": "<string>",
"experience_id": "<string>",
"delivery_subject": "<string>",
"delivery_message": "<string>",
"archived_at": "2023-11-07T05:31:56Z",
"tag_ids": ["<string>"],
"form_fields_attributes": [
{
"name": "<string>",
"id": 123,
"required": True,
"position": 123,
"options": ["<string>"],
"_destroy": True
}
],
"settings": {},
"confirmation_required": True,
"delivery_file_id": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
redirect_url: '<string>',
delivery_url: '<string>',
experience_id: '<string>',
delivery_subject: '<string>',
delivery_message: '<string>',
archived_at: '2023-11-07T05:31:56Z',
tag_ids: ['<string>'],
form_fields_attributes: [
{
name: '<string>',
id: 123,
required: true,
position: 123,
options: ['<string>'],
_destroy: true
}
],
settings: {},
confirmation_required: true,
delivery_file_id: '<string>'
})
};
fetch('https://api.crevio.co/v1/forms/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.crevio.co/v1/forms/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'redirect_url' => '<string>',
'delivery_url' => '<string>',
'experience_id' => '<string>',
'delivery_subject' => '<string>',
'delivery_message' => '<string>',
'archived_at' => '2023-11-07T05:31:56Z',
'tag_ids' => [
'<string>'
],
'form_fields_attributes' => [
[
'name' => '<string>',
'id' => 123,
'required' => true,
'position' => 123,
'options' => [
'<string>'
],
'_destroy' => true
]
],
'settings' => [
],
'confirmation_required' => true,
'delivery_file_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.crevio.co/v1/forms/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"delivery_url\": \"<string>\",\n \"experience_id\": \"<string>\",\n \"delivery_subject\": \"<string>\",\n \"delivery_message\": \"<string>\",\n \"archived_at\": \"2023-11-07T05:31:56Z\",\n \"tag_ids\": [\n \"<string>\"\n ],\n \"form_fields_attributes\": [\n {\n \"name\": \"<string>\",\n \"id\": 123,\n \"required\": true,\n \"position\": 123,\n \"options\": [\n \"<string>\"\n ],\n \"_destroy\": true\n }\n ],\n \"settings\": {},\n \"confirmation_required\": true,\n \"delivery_file_id\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.crevio.co/v1/forms/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"delivery_url\": \"<string>\",\n \"experience_id\": \"<string>\",\n \"delivery_subject\": \"<string>\",\n \"delivery_message\": \"<string>\",\n \"archived_at\": \"2023-11-07T05:31:56Z\",\n \"tag_ids\": [\n \"<string>\"\n ],\n \"form_fields_attributes\": [\n {\n \"name\": \"<string>\",\n \"id\": 123,\n \"required\": true,\n \"position\": 123,\n \"options\": [\n \"<string>\"\n ],\n \"_destroy\": true\n }\n ],\n \"settings\": {},\n \"confirmation_required\": true,\n \"delivery_file_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.crevio.co/v1/forms/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"delivery_url\": \"<string>\",\n \"experience_id\": \"<string>\",\n \"delivery_subject\": \"<string>\",\n \"delivery_message\": \"<string>\",\n \"archived_at\": \"2023-11-07T05:31:56Z\",\n \"tag_ids\": [\n \"<string>\"\n ],\n \"form_fields_attributes\": [\n {\n \"name\": \"<string>\",\n \"id\": 123,\n \"required\": true,\n \"position\": 123,\n \"options\": [\n \"<string>\"\n ],\n \"_destroy\": true\n }\n ],\n \"settings\": {},\n \"confirmation_required\": true,\n \"delivery_file_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"object": "<string>",
"name": "<string>",
"redirect_url": "<string>",
"settings": {},
"archived_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"confirmation_required": true,
"tag_ids": [
"<string>"
],
"delivery_url": "<string>",
"delivery_subject": "<string>",
"delivery_message": "<string>",
"delivery_type": "none",
"delivery_file": {},
"experience_id": "<string>",
"submissions_count": 123,
"form_fields": [
{
"id": "<string>",
"object": "<string>",
"name": "<string>",
"field_type": "email",
"required": true,
"position": 123,
"options": [
"<string>"
]
}
]
}{
"error": {
"type": "invalid_request_error",
"code": "bad_request",
"message": "The request was malformed or contained invalid parameters"
}
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "You did not provide an API key."
}
}{
"error": {
"type": "invalid_request_error",
"code": "forbidden",
"message": "You do not have permission to perform this action"
}
}{
"error": {
"type": "invalid_request_error",
"code": "resource_missing",
"message": "The requested resource was not found"
}
}{
"error": {
"type": "validation_error",
"code": "validation_failed",
"message": "Email is required",
"errors": {
"email": [
"can't be blank"
]
}
}
}{
"error": {
"type": "invalid_request_error",
"code": "rate_limit_exceeded",
"message": "Too many requests. Please retry later."
}
}{
"error": {
"type": "api_error",
"code": "internal_error",
"message": "An unexpected error occurred"
}
}Forms
Update form
Update a Form’s name, settings, confirmation behavior, or auto-tag list.
PATCH
/
forms
/
{id}
Typescript (SDK)
import { Crevio } from "@crevio/sdk";
const crevio = new Crevio({
apiKey: process.env["CREVIO_API_KEY"] ?? "",
});
async function run() {
const result = await crevio.forms.update({
id: "<id>",
formRequest: {},
});
console.log(result);
}
run();curl --request PATCH \
--url https://api.crevio.co/v1/forms/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"redirect_url": "<string>",
"delivery_url": "<string>",
"experience_id": "<string>",
"delivery_subject": "<string>",
"delivery_message": "<string>",
"archived_at": "2023-11-07T05:31:56Z",
"tag_ids": [
"<string>"
],
"form_fields_attributes": [
{
"name": "<string>",
"id": 123,
"required": true,
"position": 123,
"options": [
"<string>"
],
"_destroy": true
}
],
"settings": {},
"confirmation_required": true,
"delivery_file_id": "<string>"
}
'import requests
url = "https://api.crevio.co/v1/forms/{id}"
payload = {
"name": "<string>",
"redirect_url": "<string>",
"delivery_url": "<string>",
"experience_id": "<string>",
"delivery_subject": "<string>",
"delivery_message": "<string>",
"archived_at": "2023-11-07T05:31:56Z",
"tag_ids": ["<string>"],
"form_fields_attributes": [
{
"name": "<string>",
"id": 123,
"required": True,
"position": 123,
"options": ["<string>"],
"_destroy": True
}
],
"settings": {},
"confirmation_required": True,
"delivery_file_id": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
redirect_url: '<string>',
delivery_url: '<string>',
experience_id: '<string>',
delivery_subject: '<string>',
delivery_message: '<string>',
archived_at: '2023-11-07T05:31:56Z',
tag_ids: ['<string>'],
form_fields_attributes: [
{
name: '<string>',
id: 123,
required: true,
position: 123,
options: ['<string>'],
_destroy: true
}
],
settings: {},
confirmation_required: true,
delivery_file_id: '<string>'
})
};
fetch('https://api.crevio.co/v1/forms/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.crevio.co/v1/forms/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'redirect_url' => '<string>',
'delivery_url' => '<string>',
'experience_id' => '<string>',
'delivery_subject' => '<string>',
'delivery_message' => '<string>',
'archived_at' => '2023-11-07T05:31:56Z',
'tag_ids' => [
'<string>'
],
'form_fields_attributes' => [
[
'name' => '<string>',
'id' => 123,
'required' => true,
'position' => 123,
'options' => [
'<string>'
],
'_destroy' => true
]
],
'settings' => [
],
'confirmation_required' => true,
'delivery_file_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.crevio.co/v1/forms/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"delivery_url\": \"<string>\",\n \"experience_id\": \"<string>\",\n \"delivery_subject\": \"<string>\",\n \"delivery_message\": \"<string>\",\n \"archived_at\": \"2023-11-07T05:31:56Z\",\n \"tag_ids\": [\n \"<string>\"\n ],\n \"form_fields_attributes\": [\n {\n \"name\": \"<string>\",\n \"id\": 123,\n \"required\": true,\n \"position\": 123,\n \"options\": [\n \"<string>\"\n ],\n \"_destroy\": true\n }\n ],\n \"settings\": {},\n \"confirmation_required\": true,\n \"delivery_file_id\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.crevio.co/v1/forms/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"delivery_url\": \"<string>\",\n \"experience_id\": \"<string>\",\n \"delivery_subject\": \"<string>\",\n \"delivery_message\": \"<string>\",\n \"archived_at\": \"2023-11-07T05:31:56Z\",\n \"tag_ids\": [\n \"<string>\"\n ],\n \"form_fields_attributes\": [\n {\n \"name\": \"<string>\",\n \"id\": 123,\n \"required\": true,\n \"position\": 123,\n \"options\": [\n \"<string>\"\n ],\n \"_destroy\": true\n }\n ],\n \"settings\": {},\n \"confirmation_required\": true,\n \"delivery_file_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.crevio.co/v1/forms/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"delivery_url\": \"<string>\",\n \"experience_id\": \"<string>\",\n \"delivery_subject\": \"<string>\",\n \"delivery_message\": \"<string>\",\n \"archived_at\": \"2023-11-07T05:31:56Z\",\n \"tag_ids\": [\n \"<string>\"\n ],\n \"form_fields_attributes\": [\n {\n \"name\": \"<string>\",\n \"id\": 123,\n \"required\": true,\n \"position\": 123,\n \"options\": [\n \"<string>\"\n ],\n \"_destroy\": true\n }\n ],\n \"settings\": {},\n \"confirmation_required\": true,\n \"delivery_file_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"object": "<string>",
"name": "<string>",
"redirect_url": "<string>",
"settings": {},
"archived_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"confirmation_required": true,
"tag_ids": [
"<string>"
],
"delivery_url": "<string>",
"delivery_subject": "<string>",
"delivery_message": "<string>",
"delivery_type": "none",
"delivery_file": {},
"experience_id": "<string>",
"submissions_count": 123,
"form_fields": [
{
"id": "<string>",
"object": "<string>",
"name": "<string>",
"field_type": "email",
"required": true,
"position": 123,
"options": [
"<string>"
]
}
]
}{
"error": {
"type": "invalid_request_error",
"code": "bad_request",
"message": "The request was malformed or contained invalid parameters"
}
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "You did not provide an API key."
}
}{
"error": {
"type": "invalid_request_error",
"code": "forbidden",
"message": "You do not have permission to perform this action"
}
}{
"error": {
"type": "invalid_request_error",
"code": "resource_missing",
"message": "The requested resource was not found"
}
}{
"error": {
"type": "validation_error",
"code": "validation_failed",
"message": "Email is required",
"errors": {
"email": [
"can't be blank"
]
}
}
}{
"error": {
"type": "invalid_request_error",
"code": "rate_limit_exceeded",
"message": "Too many requests. Please retry later."
}
}{
"error": {
"type": "api_error",
"code": "internal_error",
"message": "An unexpected error occurred"
}
}Authorizations
API key in the format: Bearer {api_token}
Path Parameters
The form's ID.
Body
application/json
Full https:// URL people land on after they click the confirmation link, with confirmation_required on.
What everyone who submits gets by email, on every submission. none turns delivery off; file needs delivery_file_id, link needs delivery_url, experience needs experience_id.
Available options:
none, file, link, experience Full https:// URL to send: a page, video or download elsewhere.
Experience ID to grant access to; the email carries a sign-in link.
Subject of the delivery email. Defaults to "Your freebie from is here!".
Plain-text body of the delivery email; the download button is added below it.
Tag IDs added to everyone who submits (never replacing their other tags). With confirmation_required, once they confirm.
Nested-attributes payload for creating, updating, or destroying fields in one round-trip. Pass id to update an existing field; pass _destroy: true to remove one.
Show child attributes
Show child attributes
Double opt-in: tags and the lead magnet wait until the person clicks the confirmation link.
File ID (file_..., from the Files API) to send as a download.
Response
Updated form
Available options:
none, file, link, experience Show child attributes
Show child attributes
Was this page helpful?