{"id":3175,"date":"2026-05-07T06:33:14","date_gmt":"2026-05-07T06:33:14","guid":{"rendered":"https:\/\/help.contentsnare.com\/?post_type=ht_kb&p=3175"},"modified":"2026-05-07T06:33:15","modified_gmt":"2026-05-07T06:33:15","slug":"api-create-request-with-fields","status":"publish","type":"ht_kb","link":"https:\/\/help.contentsnare.com\/knowledge-base\/api-create-request-with-fields\/","title":{"rendered":"API: Create Request with Fields"},"content":{"rendered":"\n
\n

Please note:<\/strong> This endpoint is currently in alpha and is not guaranteed to be backwards compatible. It works well right now for creating fully structured requests in Content Snare from AI.<\/p>\n<\/div>\n\n\n\n

The Create Request<\/strong> endpoint lets you build a complete request in a single API call, including pages, sections, and fields. You do not need a pre-built template.<\/p>\n\n\n\n

Endpoint:<\/strong> POST \/partner_api\/v1\/requests<\/code>
Required scopes:<\/strong> write_requests<\/code>, write_clients<\/code> (if the client doesn’t already exist)<\/p>\n\n\n\n

Request Body<\/h2>\n\n\n\n

Top-level properties<\/h3>\n\n\n\n
Property<\/th>Type<\/th>Required<\/th>Description<\/th><\/tr><\/thead>
name<\/code><\/td>string<\/td>Yes<\/td>The name of the request<\/td><\/tr>
client_email<\/code><\/td>string<\/td>Yes<\/td>Client’s email address. If the client doesn’t exist, one will be created automatically<\/td><\/tr>
client_full_name<\/code><\/td>string<\/td>If new client<\/td>Full name for the client (required when creating a new client)<\/td><\/tr>
company_name<\/code><\/td>string<\/td>No<\/td>Company name for the client<\/td><\/tr>
folder_name<\/code><\/td>string<\/td>No<\/td>Folder to organise the request into<\/td><\/tr>
due<\/code><\/td>string<\/td>No<\/td>Due date in yyyy-mm-dd<\/code> format<\/td><\/tr>
status<\/code><\/td>string<\/td>No<\/td>\"draft\"<\/code> (default) or \"published\"<\/code><\/td><\/tr>
owner_id<\/code><\/td>string<\/td>No<\/td>Team member ID to assign as owner<\/td><\/tr>
owner_email<\/code><\/td>string<\/td>No<\/td>Team member email to assign as owner (alternative to owner_id<\/code>)<\/td><\/tr>
communication_template_id<\/code><\/td>string<\/td>No<\/td>ID of a communications schedule to attach<\/td><\/tr>
communication_template_name<\/code><\/td>string<\/td>No<\/td>Name of a communications schedule (alternative to ID)<\/td><\/tr>
comments_enabled<\/code><\/td>boolean<\/td>No<\/td>Allow the client to leave comments<\/td><\/tr>
passcode_enabled<\/code><\/td>boolean<\/td>No<\/td>Require a PIN code to access<\/td><\/tr>
share_via_link_enabled<\/code><\/td>boolean<\/td>No<\/td>Allow the client to share the request via link<\/td><\/tr>
pages_data<\/code><\/td>array<\/td>Yes<\/td>Array of page objects (see below)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Structure: Pages, Sections, and Questions<\/h2>\n\n\n\n

A request is organised into pages (the tabs your client sees), each containing one or more sections, each containing one or more questions (fields).<\/p>\n\n\n\n

Request\n\u251c\u2500\u2500 Page 1\n\u2502   \u251c\u2500\u2500 Section A\n\u2502   \u2502   \u251c\u2500\u2500 Question 1\n\u2502   \u2502   \u251c\u2500\u2500 Question 2\n\u2502   \u2502   \u2514\u2500\u2500 Question 3\n\u2502   \u2514\u2500\u2500 Section B\n\u2502       \u2514\u2500\u2500 Question 4\n\u2514\u2500\u2500 Page 2\n    \u2514\u2500\u2500 Section C\n        \u251c\u2500\u2500 Question 5\n        \u2514\u2500\u2500 Question 6<\/code><\/pre>\n\n\n\n
Page object<\/h3>\n\n\n\n
Property<\/th>Type<\/th>Required<\/th>Description<\/th><\/tr><\/thead>
name<\/code><\/td>string<\/td>Yes<\/td>Page name (displayed as a tab)<\/td><\/tr>
sections_data<\/code><\/td>array<\/td>Yes<\/td>Array of section objects<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Section object<\/h3>\n\n\n\n
Property<\/th>Type<\/th>Required<\/th>Description<\/th><\/tr><\/thead>
name<\/code><\/td>string<\/td>Yes<\/td>Section heading<\/td><\/tr>
questions_data<\/code><\/td>array<\/td>Yes<\/td>Array of question objects<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Question object<\/h3>\n\n\n\n
Property<\/th>Type<\/th>Required<\/th>Description<\/th><\/tr><\/thead>
question<\/code><\/td>string<\/td>Yes<\/td>The question or field label displayed to the client<\/td><\/tr>
data_type<\/code><\/td>string<\/td>Yes<\/td>The field type (see full list below)<\/td><\/tr>
question_number<\/code><\/td>integer<\/td>Yes<\/td>Sequential number starting from 1, unique across the entire request<\/td><\/tr>
options<\/code><\/td>array of strings<\/td>Conditional<\/td>Required for: single select option<\/code>, multi select options<\/code>, dropdown<\/code>, task list<\/code><\/td><\/tr>
columns<\/code><\/td>array of strings<\/td>Conditional<\/td>Required for: table<\/code><\/td><\/tr>
instructions<\/code><\/td>string<\/td>No<\/td>Help text shown to the client explaining how to complete the field<\/td><\/tr>
show_when<\/code><\/td>object<\/td>No<\/td>Conditional visibility rules (see below)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Field Types (data_type)<\/h2>\n\n\n\n
Text input<\/h3>\n\n\n\n
Value<\/th>Description<\/th><\/tr><\/thead>
single-line<\/code><\/td>Single-line text input<\/td><\/tr>
text<\/code><\/td>Standard text input<\/td><\/tr>
multi-line text<\/code><\/td>Multi-line textarea<\/td><\/tr>
formatted text<\/code><\/td>Rich text editor<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Contact information<\/h3>\n\n\n\n
Value<\/th>Description<\/th><\/tr><\/thead>
email<\/code><\/td>Email address with validation<\/td><\/tr>
phone<\/code><\/td>Phone number input<\/td><\/tr>
url<\/code><\/td>URL with validation<\/td><\/tr>
address<\/code><\/td>Structured address fields<\/td><\/tr>
country select<\/code><\/td>Country dropdown<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
File uploads<\/h3>\n\n\n\n
Value<\/th>Description<\/th><\/tr><\/thead>
single image upload<\/code><\/td>Upload one image<\/td><\/tr>
multiple image upload<\/code><\/td>Upload multiple images<\/td><\/tr>
single file upload<\/code><\/td>Upload one file<\/td><\/tr>
multiple file upload<\/code><\/td>Upload multiple files<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Numbers and dates<\/h3>\n\n\n\n
Value<\/th>Description<\/th><\/tr><\/thead>
number<\/code><\/td>Numeric input<\/td><\/tr>
currency<\/code><\/td>Currency\/monetary value<\/td><\/tr>
date\/time<\/code><\/td>Date and time picker<\/td><\/tr>
date range<\/code><\/td>Start and end date selection<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Ratings<\/h3>\n\n\n\n
Value<\/th>Description<\/th><\/tr><\/thead>
numeric rating<\/code><\/td>Numeric scale rating<\/td><\/tr>
star rating<\/code><\/td>Star-based rating<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Selection fields<\/h3>\n\n\n\n
These types require the options<\/code> array.<\/p>\n\n\n\n
Value<\/th>Description<\/th><\/tr><\/thead>
single select option<\/code><\/td>Radio-button-style single selection<\/td><\/tr>
multi select options<\/code><\/td>Checkbox-style multiple selection<\/td><\/tr>
dropdown<\/code><\/td>Dropdown single selection<\/td><\/tr>
task list<\/code><\/td>Checklist of items<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Data entry<\/h3>\n\n\n\n
This type requires the columns<\/code> array.<\/p>\n\n\n\n
Value<\/th>Description<\/th><\/tr><\/thead>
table<\/code><\/td>Table with defined column headers; client adds rows<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Other<\/h3>\n\n\n\n
Value<\/th>Description<\/th><\/tr><\/thead>
signature<\/code><\/td>Signature capture<\/td><\/tr>
button<\/code><\/td>Clickable button<\/td><\/tr>
icon<\/code><\/td>Icon field<\/td><\/tr>
color picker<\/code><\/td>Color selection<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Conditional Visibility (show_when)<\/h2>\n\n\n\n
Questions can be shown or hidden based on your client’s answers to other questions. This lets you build dynamic, branching forms.<\/p>\n\n\n\n
{\n  \"show_when\": {\n    \"conditions\": [\n      {\n        \"question_number\": 1,\n        \"condition\": \"equals\",\n        \"value\": \"Yes\"\n      }\n    ],\n    \"logical_operator\": \"and\"\n  }\n}<\/code><\/pre>\n\n\n\n
show_when properties<\/h3>\n\n\n\n
Property<\/th>Type<\/th>Required<\/th>Description<\/th><\/tr><\/thead>
conditions<\/code><\/td>array<\/td>Yes<\/td>One or more condition objects<\/td><\/tr>
logical_operator<\/code><\/td>string<\/td>When 2+ conditions<\/td>\"and\"<\/code> (all must match) or \"or\"<\/code> (any must match)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Condition object<\/h3>\n\n\n\n
Property<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
question_number<\/code><\/td>integer<\/td>The question_number<\/code> of the field to evaluate<\/td><\/tr>
condition<\/code><\/td>string<\/td>The comparison operator (see below)<\/td><\/tr>
value<\/code><\/td>string<\/td>The value to compare against<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Available conditions<\/h3>\n\n\n\n
Condition<\/th>Description<\/th><\/tr><\/thead>
contains<\/code><\/td>Field value contains the specified text<\/td><\/tr>
equals<\/code><\/td>Field value exactly matches<\/td><\/tr>
does not equal<\/code><\/td>Field value does not match<\/td><\/tr>
less than<\/code><\/td>Numeric comparison<\/td><\/tr>
greater than<\/code><\/td>Numeric comparison<\/td><\/tr>
is empty<\/code><\/td>Field has no value<\/td><\/tr>
has a value<\/code><\/td>Field has any value<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Full Example<\/h2>\n\n\n\n
This example creates a vendor onboarding form with two pages, conditional logic, and a variety of field types.<\/p>\n\n\n\n
{\n  \"name\": \"Vendor Application Form\",\n  \"client_email\": \"vendor@example.com\",\n  \"client_full_name\": \"Jane Smith\",\n  \"company_name\": \"Smith Supplies\",\n  \"due\": \"2026-04-15\",\n  \"status\": \"published\",\n  \"pages_data\": [\n    {\n      \"name\": \"Company Information\",\n      \"sections_data\": [\n        {\n          \"name\": \"Basic Details\",\n          \"questions_data\": [\n            {\n              \"question\": \"Legal business name\",\n              \"data_type\": \"single-line\",\n              \"question_number\": 1\n            },\n            {\n              \"question\": \"Business type\",\n              \"data_type\": \"dropdown\",\n              \"question_number\": 2,\n              \"options\": [\"Sole Proprietor\", \"Partnership\", \"Corporation\", \"LLC\", \"Other\"]\n            },\n            {\n              \"question\": \"If Other, please specify\",\n              \"data_type\": \"single-line\",\n              \"question_number\": 3,\n              \"show_when\": {\n                \"conditions\": [\n                  { \"question_number\": 2, \"condition\": \"equals\", \"value\": \"Other\" }\n                ]\n              }\n            },\n            {\n              \"question\": \"Business address\",\n              \"data_type\": \"address\",\n              \"question_number\": 4\n            },\n            {\n              \"question\": \"Company website\",\n              \"data_type\": \"url\",\n              \"question_number\": 5\n            },\n            {\n              \"question\": \"Contact phone\",\n              \"data_type\": \"phone\",\n              \"question_number\": 6\n            }\n          ]\n        },\n        {\n          \"name\": \"Company Profile\",\n          \"questions_data\": [\n            {\n              \"question\": \"Company logo\",\n              \"data_type\": \"single image upload\",\n              \"question_number\": 7,\n              \"instructions\": \"Please upload a high-resolution PNG or SVG file\"\n            },\n            {\n              \"question\": \"Describe your products or services\",\n              \"data_type\": \"multi-line text\",\n              \"question_number\": 8\n            },\n            {\n              \"question\": \"How would you rate your production capacity?\",\n              \"data_type\": \"star rating\",\n              \"question_number\": 9\n            }\n          ]\n        }\n      ]\n    },\n    {\n      \"name\": \"Compliance & Documents\",\n      \"sections_data\": [\n        {\n          \"name\": \"Certifications\",\n          \"questions_data\": [\n            {\n              \"question\": \"Do you hold any industry certifications?\",\n              \"data_type\": \"single select option\",\n              \"question_number\": 10,\n              \"options\": [\"Yes\", \"No\"]\n            },\n            {\n              \"question\": \"Upload certification documents\",\n              \"data_type\": \"multiple file upload\",\n              \"question_number\": 11,\n              \"instructions\": \"PDF or scanned copies accepted\",\n              \"show_when\": {\n                \"conditions\": [\n                  { \"question_number\": 10, \"condition\": \"equals\", \"value\": \"Yes\" }\n                ]\n              }\n            },\n            {\n              \"question\": \"List certifications and expiry dates\",\n              \"data_type\": \"table\",\n              \"question_number\": 12,\n              \"columns\": [\"Certification Name\", \"Issuing Body\", \"Expiry Date\"],\n              \"show_when\": {\n                \"conditions\": [\n                  { \"question_number\": 10, \"condition\": \"equals\", \"value\": \"Yes\" }\n                ]\n              }\n            }\n          ]\n        },\n        {\n          \"name\": \"Agreement\",\n          \"questions_data\": [\n            {\n              \"question\": \"Compliance checklist\",\n              \"data_type\": \"task list\",\n              \"question_number\": 13,\n              \"options\": [\n                \"I agree to the Terms of Service\",\n                \"I have read the Privacy Policy\",\n                \"I confirm all information is accurate\"\n              ]\n            },\n            {\n              \"question\": \"Authorized signature\",\n              \"data_type\": \"signature\",\n              \"question_number\": 14\n            },\n            {\n              \"question\": \"Date signed\",\n              \"data_type\": \"date\/time\",\n              \"question_number\": 15\n            }\n          ]\n        }\n      ]\n    }\n  ]\n}<\/code><\/pre>\n\n\n\n
Notes<\/h2>\n\n\n\n
    \n
  • question_number<\/code>\u00a0must be unique across the entire request, not just within a section. Start at 1 and increment sequentially.<\/li>\n\n\n\n
  • Conditional references use\u00a0question_number<\/code>, so a question on Page 2 can reference a question on Page 1.<\/li>\n\n\n\n
  • New clients are created automatically if no client with the given\u00a0client_email<\/code>\u00a0exists. In that case,\u00a0client_full_name<\/code>\u00a0is required.<\/li>\n\n\n\n
  • Draft vs. published: requests created as\u00a0\"draft\"<\/code>\u00a0are not visible to the client until you change the status to\u00a0\"published\"<\/code>.<\/li>\n\n\n\n
  • Rate limits: the API allows 20 write operations per 10 seconds.<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"
    Please note: This endpoint is currently in alpha and is not guaranteed to be backwards compatible. It works well right now for creating fully structured requests in Content Snare from AI. The Create Request endpoint lets you build a complete request in a single API call, including pages, sections, and fields. You…<\/p>\n","protected":false},"author":1,"comment_status":"closed","ping_status":"closed","template":"","format":"standard","meta":{"footnotes":""},"ht-kb-category":[1040],"ht-kb-tag":[],"class_list":["post-3175","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-integrations"],"_links":{"self":[{"href":"https:\/\/help.contentsnare.com\/wp-json\/wp\/v2\/ht-kb\/3175","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.contentsnare.com\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/help.contentsnare.com\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/help.contentsnare.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/help.contentsnare.com\/wp-json\/wp\/v2\/comments?post=3175"}],"version-history":[{"count":18,"href":"https:\/\/help.contentsnare.com\/wp-json\/wp\/v2\/ht-kb\/3175\/revisions"}],"predecessor-version":[{"id":3193,"href":"https:\/\/help.contentsnare.com\/wp-json\/wp\/v2\/ht-kb\/3175\/revisions\/3193"}],"wp:attachment":[{"href":"https:\/\/help.contentsnare.com\/wp-json\/wp\/v2\/media?parent=3175"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/help.contentsnare.com\/wp-json\/wp\/v2\/ht-kb-category?post=3175"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/help.contentsnare.com\/wp-json\/wp\/v2\/ht-kb-tag?post=3175"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}