curl --request POST \
--url https://{subdomain}.conveyour.com/api/form/collections \
--header 'Content-Type: application/json' \
--header 'x-conveyour-token: <api-key>' \
--data '
{
"name": "<string>",
"label": "<string>",
"label_plural": "<string>",
"schema": {},
"email_alerts": {}
}
'const options = {
method: 'POST',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
label: '<string>',
label_plural: '<string>',
schema: {},
email_alerts: {}
})
};
fetch('https://{subdomain}.conveyour.com/api/form/collections', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
label: '<string>',
label_plural: '<string>',
schema: {},
email_alerts: {}
})
};
fetch('https://{subdomain}.conveyour.com/api/form/collections', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/form/collections"
payload = {
"name": "<string>",
"label": "<string>",
"label_plural": "<string>",
"schema": {},
"email_alerts": {}
}
headers = {
"x-conveyour-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.conveyour.com/api/form/collections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'label' => '<string>',
'label_plural' => '<string>',
'schema' => [
],
'email_alerts' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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": "<string>",
"data": {
"id": "<string>",
"org_id": 123,
"user_id": 123,
"name": "<string>",
"label": "<string>",
"label_plural": "<string>",
"schema": {},
"email_alerts": {},
"external_id": "<string>",
"external_created_at": "<string>",
"external_updated_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
}{
"status": "failed",
"message": "<string>",
"data": {}
}Create a form collection
Creates a form definition.
Permission: requires manage_forms.
curl --request POST \
--url https://{subdomain}.conveyour.com/api/form/collections \
--header 'Content-Type: application/json' \
--header 'x-conveyour-token: <api-key>' \
--data '
{
"name": "<string>",
"label": "<string>",
"label_plural": "<string>",
"schema": {},
"email_alerts": {}
}
'const options = {
method: 'POST',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
label: '<string>',
label_plural: '<string>',
schema: {},
email_alerts: {}
})
};
fetch('https://{subdomain}.conveyour.com/api/form/collections', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
label: '<string>',
label_plural: '<string>',
schema: {},
email_alerts: {}
})
};
fetch('https://{subdomain}.conveyour.com/api/form/collections', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/form/collections"
payload = {
"name": "<string>",
"label": "<string>",
"label_plural": "<string>",
"schema": {},
"email_alerts": {}
}
headers = {
"x-conveyour-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.conveyour.com/api/form/collections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'label' => '<string>',
'label_plural' => '<string>',
'schema' => [
],
'email_alerts' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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": "<string>",
"data": {
"id": "<string>",
"org_id": 123,
"user_id": 123,
"name": "<string>",
"label": "<string>",
"label_plural": "<string>",
"schema": {},
"email_alerts": {},
"external_id": "<string>",
"external_created_at": "<string>",
"external_updated_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
}{
"status": "failed",
"message": "<string>",
"data": {}
}Authorizations
Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.
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
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 form collection — the definition of a form. It carries the custom object fields plus a locked, required Form Name and email alert configuration.
Show child attributes
Show child attributes