API v1
PUT
Add new fields to a Template
{{baseUrl}}/templates/:template_id/add_fields
QUERY PARAMS
template_id
BODY json
{
"fields": [
{
"alignment": "",
"autoCalculateMaxLength": false,
"backgroundColor": "",
"backgroundColorFieldName": "",
"backgroundColorFieldRequired": false,
"barcodeSymbology": "",
"bold": false,
"characterSpacing": "",
"checkCharacter": "",
"checkColor": "",
"checkColorFieldName": "",
"checkColorFieldRequired": false,
"color": "",
"colorFieldName": "",
"colorFieldRequired": false,
"comb": false,
"combNumberOfCells": "",
"combValueOffset": "",
"combinedFieldFormat": "",
"combinedFieldNames": "",
"combinedFieldSeparator": "",
"combinedFieldType": "",
"condition": "",
"currency": false,
"dateTimeFormat": "",
"decimalPlaces": "",
"default": "",
"description": "",
"displayType": "",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"falseText": "",
"fontSize": "",
"height": "",
"hidden": false,
"id": "",
"imageGravity": "",
"imageScaleType": "",
"includeTime": false,
"integer": false,
"invertBooleanCondition": false,
"maxLength": "",
"maximum": "",
"metadata": "",
"minLength": "",
"minimum": "",
"multiline": false,
"multilineLines": "",
"name": "",
"numberConditionRangeExclusiveMax": false,
"numberConditionRangeExclusiveMin": false,
"numberConditionRangeMax": "",
"numberConditionRangeMin": "",
"numberConditionType": "",
"opacity": "",
"optionList": "",
"overflow": "",
"page": "",
"placeholder": "",
"qrcodeColor": "",
"qrcodeColorFieldName": "",
"qrcodeColorFieldRequired": false,
"required": false,
"rotation": "",
"shapeBorderColor": "",
"shapeBorderColorFieldName": "",
"shapeBorderColorFieldRequired": false,
"shapeBorderWidth": "",
"shapeFillColor": "",
"shapeFillColorFieldName": "",
"shapeFillColorFieldRequired": false,
"shapeType": "",
"signatureAllowDraw": false,
"signatureAllowType": false,
"static": false,
"strikethrough": false,
"stringConditionType": "",
"title": "",
"trueText": "",
"type": "",
"typeface": "",
"uppercase": false,
"vAlignment": "",
"width": "",
"x": "",
"y": ""
}
]
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/templates/:template_id/add_fields");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"fields\": [\n {\n \"alignment\": \"\",\n \"autoCalculateMaxLength\": false,\n \"backgroundColor\": \"\",\n \"backgroundColorFieldName\": \"\",\n \"backgroundColorFieldRequired\": false,\n \"barcodeSymbology\": \"\",\n \"bold\": false,\n \"characterSpacing\": \"\",\n \"checkCharacter\": \"\",\n \"checkColor\": \"\",\n \"checkColorFieldName\": \"\",\n \"checkColorFieldRequired\": false,\n \"color\": \"\",\n \"colorFieldName\": \"\",\n \"colorFieldRequired\": false,\n \"comb\": false,\n \"combNumberOfCells\": \"\",\n \"combValueOffset\": \"\",\n \"combinedFieldFormat\": \"\",\n \"combinedFieldNames\": \"\",\n \"combinedFieldSeparator\": \"\",\n \"combinedFieldType\": \"\",\n \"condition\": \"\",\n \"currency\": false,\n \"dateTimeFormat\": \"\",\n \"decimalPlaces\": \"\",\n \"default\": \"\",\n \"description\": \"\",\n \"displayType\": \"\",\n \"exclusiveMaximum\": false,\n \"exclusiveMinimum\": false,\n \"falseText\": \"\",\n \"fontSize\": \"\",\n \"height\": \"\",\n \"hidden\": false,\n \"id\": \"\",\n \"imageGravity\": \"\",\n \"imageScaleType\": \"\",\n \"includeTime\": false,\n \"integer\": false,\n \"invertBooleanCondition\": false,\n \"maxLength\": \"\",\n \"maximum\": \"\",\n \"metadata\": \"\",\n \"minLength\": \"\",\n \"minimum\": \"\",\n \"multiline\": false,\n \"multilineLines\": \"\",\n \"name\": \"\",\n \"numberConditionRangeExclusiveMax\": false,\n \"numberConditionRangeExclusiveMin\": false,\n \"numberConditionRangeMax\": \"\",\n \"numberConditionRangeMin\": \"\",\n \"numberConditionType\": \"\",\n \"opacity\": \"\",\n \"optionList\": \"\",\n \"overflow\": \"\",\n \"page\": \"\",\n \"placeholder\": \"\",\n \"qrcodeColor\": \"\",\n \"qrcodeColorFieldName\": \"\",\n \"qrcodeColorFieldRequired\": false,\n \"required\": false,\n \"rotation\": \"\",\n \"shapeBorderColor\": \"\",\n \"shapeBorderColorFieldName\": \"\",\n \"shapeBorderColorFieldRequired\": false,\n \"shapeBorderWidth\": \"\",\n \"shapeFillColor\": \"\",\n \"shapeFillColorFieldName\": \"\",\n \"shapeFillColorFieldRequired\": false,\n \"shapeType\": \"\",\n \"signatureAllowDraw\": false,\n \"signatureAllowType\": false,\n \"static\": false,\n \"strikethrough\": false,\n \"stringConditionType\": \"\",\n \"title\": \"\",\n \"trueText\": \"\",\n \"type\": \"\",\n \"typeface\": \"\",\n \"uppercase\": false,\n \"vAlignment\": \"\",\n \"width\": \"\",\n \"x\": \"\",\n \"y\": \"\"\n }\n ]\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/templates/:template_id/add_fields" {:content-type :json
:form-params {:fields [{:alignment ""
:autoCalculateMaxLength false
:backgroundColor ""
:backgroundColorFieldName ""
:backgroundColorFieldRequired false
:barcodeSymbology ""
:bold false
:characterSpacing ""
:checkCharacter ""
:checkColor ""
:checkColorFieldName ""
:checkColorFieldRequired false
:color ""
:colorFieldName ""
:colorFieldRequired false
:comb false
:combNumberOfCells ""
:combValueOffset ""
:combinedFieldFormat ""
:combinedFieldNames ""
:combinedFieldSeparator ""
:combinedFieldType ""
:condition ""
:currency false
:dateTimeFormat ""
:decimalPlaces ""
:default ""
:description ""
:displayType ""
:exclusiveMaximum false
:exclusiveMinimum false
:falseText ""
:fontSize ""
:height ""
:hidden false
:id ""
:imageGravity ""
:imageScaleType ""
:includeTime false
:integer false
:invertBooleanCondition false
:maxLength ""
:maximum ""
:metadata ""
:minLength ""
:minimum ""
:multiline false
:multilineLines ""
:name ""
:numberConditionRangeExclusiveMax false
:numberConditionRangeExclusiveMin false
:numberConditionRangeMax ""
:numberConditionRangeMin ""
:numberConditionType ""
:opacity ""
:optionList ""
:overflow ""
:page ""
:placeholder ""
:qrcodeColor ""
:qrcodeColorFieldName ""
:qrcodeColorFieldRequired false
:required false
:rotation ""
:shapeBorderColor ""
:shapeBorderColorFieldName ""
:shapeBorderColorFieldRequired false
:shapeBorderWidth ""
:shapeFillColor ""
:shapeFillColorFieldName ""
:shapeFillColorFieldRequired false
:shapeType ""
:signatureAllowDraw false
:signatureAllowType false
:static false
:strikethrough false
:stringConditionType ""
:title ""
:trueText ""
:type ""
:typeface ""
:uppercase false
:vAlignment ""
:width ""
:x ""
:y ""}]}})require "http/client"
url = "{{baseUrl}}/templates/:template_id/add_fields"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"fields\": [\n {\n \"alignment\": \"\",\n \"autoCalculateMaxLength\": false,\n \"backgroundColor\": \"\",\n \"backgroundColorFieldName\": \"\",\n \"backgroundColorFieldRequired\": false,\n \"barcodeSymbology\": \"\",\n \"bold\": false,\n \"characterSpacing\": \"\",\n \"checkCharacter\": \"\",\n \"checkColor\": \"\",\n \"checkColorFieldName\": \"\",\n \"checkColorFieldRequired\": false,\n \"color\": \"\",\n \"colorFieldName\": \"\",\n \"colorFieldRequired\": false,\n \"comb\": false,\n \"combNumberOfCells\": \"\",\n \"combValueOffset\": \"\",\n \"combinedFieldFormat\": \"\",\n \"combinedFieldNames\": \"\",\n \"combinedFieldSeparator\": \"\",\n \"combinedFieldType\": \"\",\n \"condition\": \"\",\n \"currency\": false,\n \"dateTimeFormat\": \"\",\n \"decimalPlaces\": \"\",\n \"default\": \"\",\n \"description\": \"\",\n \"displayType\": \"\",\n \"exclusiveMaximum\": false,\n \"exclusiveMinimum\": false,\n \"falseText\": \"\",\n \"fontSize\": \"\",\n \"height\": \"\",\n \"hidden\": false,\n \"id\": \"\",\n \"imageGravity\": \"\",\n \"imageScaleType\": \"\",\n \"includeTime\": false,\n \"integer\": false,\n \"invertBooleanCondition\": false,\n \"maxLength\": \"\",\n \"maximum\": \"\",\n \"metadata\": \"\",\n \"minLength\": \"\",\n \"minimum\": \"\",\n \"multiline\": false,\n \"multilineLines\": \"\",\n \"name\": \"\",\n \"numberConditionRangeExclusiveMax\": false,\n \"numberConditionRangeExclusiveMin\": false,\n \"numberConditionRangeMax\": \"\",\n \"numberConditionRangeMin\": \"\",\n \"numberConditionType\": \"\",\n \"opacity\": \"\",\n \"optionList\": \"\",\n \"overflow\": \"\",\n \"page\": \"\",\n \"placeholder\": \"\",\n \"qrcodeColor\": \"\",\n \"qrcodeColorFieldName\": \"\",\n \"qrcodeColorFieldRequired\": false,\n \"required\": false,\n \"rotation\": \"\",\n \"shapeBorderColor\": \"\",\n \"shapeBorderColorFieldName\": \"\",\n \"shapeBorderColorFieldRequired\": false,\n \"shapeBorderWidth\": \"\",\n \"shapeFillColor\": \"\",\n \"shapeFillColorFieldName\": \"\",\n \"shapeFillColorFieldRequired\": false,\n \"shapeType\": \"\",\n \"signatureAllowDraw\": false,\n \"signatureAllowType\": false,\n \"static\": false,\n \"strikethrough\": false,\n \"stringConditionType\": \"\",\n \"title\": \"\",\n \"trueText\": \"\",\n \"type\": \"\",\n \"typeface\": \"\",\n \"uppercase\": false,\n \"vAlignment\": \"\",\n \"width\": \"\",\n \"x\": \"\",\n \"y\": \"\"\n }\n ]\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/templates/:template_id/add_fields"),
Content = new StringContent("{\n \"fields\": [\n {\n \"alignment\": \"\",\n \"autoCalculateMaxLength\": false,\n \"backgroundColor\": \"\",\n \"backgroundColorFieldName\": \"\",\n \"backgroundColorFieldRequired\": false,\n \"barcodeSymbology\": \"\",\n \"bold\": false,\n \"characterSpacing\": \"\",\n \"checkCharacter\": \"\",\n \"checkColor\": \"\",\n \"checkColorFieldName\": \"\",\n \"checkColorFieldRequired\": false,\n \"color\": \"\",\n \"colorFieldName\": \"\",\n \"colorFieldRequired\": false,\n \"comb\": false,\n \"combNumberOfCells\": \"\",\n \"combValueOffset\": \"\",\n \"combinedFieldFormat\": \"\",\n \"combinedFieldNames\": \"\",\n \"combinedFieldSeparator\": \"\",\n \"combinedFieldType\": \"\",\n \"condition\": \"\",\n \"currency\": false,\n \"dateTimeFormat\": \"\",\n \"decimalPlaces\": \"\",\n \"default\": \"\",\n \"description\": \"\",\n \"displayType\": \"\",\n \"exclusiveMaximum\": false,\n \"exclusiveMinimum\": false,\n \"falseText\": \"\",\n \"fontSize\": \"\",\n \"height\": \"\",\n \"hidden\": false,\n \"id\": \"\",\n \"imageGravity\": \"\",\n \"imageScaleType\": \"\",\n \"includeTime\": false,\n \"integer\": false,\n \"invertBooleanCondition\": false,\n \"maxLength\": \"\",\n \"maximum\": \"\",\n \"metadata\": \"\",\n \"minLength\": \"\",\n \"minimum\": \"\",\n \"multiline\": false,\n \"multilineLines\": \"\",\n \"name\": \"\",\n \"numberConditionRangeExclusiveMax\": false,\n \"numberConditionRangeExclusiveMin\": false,\n \"numberConditionRangeMax\": \"\",\n \"numberConditionRangeMin\": \"\",\n \"numberConditionType\": \"\",\n \"opacity\": \"\",\n \"optionList\": \"\",\n \"overflow\": \"\",\n \"page\": \"\",\n \"placeholder\": \"\",\n \"qrcodeColor\": \"\",\n \"qrcodeColorFieldName\": \"\",\n \"qrcodeColorFieldRequired\": false,\n \"required\": false,\n \"rotation\": \"\",\n \"shapeBorderColor\": \"\",\n \"shapeBorderColorFieldName\": \"\",\n \"shapeBorderColorFieldRequired\": false,\n \"shapeBorderWidth\": \"\",\n \"shapeFillColor\": \"\",\n \"shapeFillColorFieldName\": \"\",\n \"shapeFillColorFieldRequired\": false,\n \"shapeType\": \"\",\n \"signatureAllowDraw\": false,\n \"signatureAllowType\": false,\n \"static\": false,\n \"strikethrough\": false,\n \"stringConditionType\": \"\",\n \"title\": \"\",\n \"trueText\": \"\",\n \"type\": \"\",\n \"typeface\": \"\",\n \"uppercase\": false,\n \"vAlignment\": \"\",\n \"width\": \"\",\n \"x\": \"\",\n \"y\": \"\"\n }\n ]\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/templates/:template_id/add_fields");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"fields\": [\n {\n \"alignment\": \"\",\n \"autoCalculateMaxLength\": false,\n \"backgroundColor\": \"\",\n \"backgroundColorFieldName\": \"\",\n \"backgroundColorFieldRequired\": false,\n \"barcodeSymbology\": \"\",\n \"bold\": false,\n \"characterSpacing\": \"\",\n \"checkCharacter\": \"\",\n \"checkColor\": \"\",\n \"checkColorFieldName\": \"\",\n \"checkColorFieldRequired\": false,\n \"color\": \"\",\n \"colorFieldName\": \"\",\n \"colorFieldRequired\": false,\n \"comb\": false,\n \"combNumberOfCells\": \"\",\n \"combValueOffset\": \"\",\n \"combinedFieldFormat\": \"\",\n \"combinedFieldNames\": \"\",\n \"combinedFieldSeparator\": \"\",\n \"combinedFieldType\": \"\",\n \"condition\": \"\",\n \"currency\": false,\n \"dateTimeFormat\": \"\",\n \"decimalPlaces\": \"\",\n \"default\": \"\",\n \"description\": \"\",\n \"displayType\": \"\",\n \"exclusiveMaximum\": false,\n \"exclusiveMinimum\": false,\n \"falseText\": \"\",\n \"fontSize\": \"\",\n \"height\": \"\",\n \"hidden\": false,\n \"id\": \"\",\n \"imageGravity\": \"\",\n \"imageScaleType\": \"\",\n \"includeTime\": false,\n \"integer\": false,\n \"invertBooleanCondition\": false,\n \"maxLength\": \"\",\n \"maximum\": \"\",\n \"metadata\": \"\",\n \"minLength\": \"\",\n \"minimum\": \"\",\n \"multiline\": false,\n \"multilineLines\": \"\",\n \"name\": \"\",\n \"numberConditionRangeExclusiveMax\": false,\n \"numberConditionRangeExclusiveMin\": false,\n \"numberConditionRangeMax\": \"\",\n \"numberConditionRangeMin\": \"\",\n \"numberConditionType\": \"\",\n \"opacity\": \"\",\n \"optionList\": \"\",\n \"overflow\": \"\",\n \"page\": \"\",\n \"placeholder\": \"\",\n \"qrcodeColor\": \"\",\n \"qrcodeColorFieldName\": \"\",\n \"qrcodeColorFieldRequired\": false,\n \"required\": false,\n \"rotation\": \"\",\n \"shapeBorderColor\": \"\",\n \"shapeBorderColorFieldName\": \"\",\n \"shapeBorderColorFieldRequired\": false,\n \"shapeBorderWidth\": \"\",\n \"shapeFillColor\": \"\",\n \"shapeFillColorFieldName\": \"\",\n \"shapeFillColorFieldRequired\": false,\n \"shapeType\": \"\",\n \"signatureAllowDraw\": false,\n \"signatureAllowType\": false,\n \"static\": false,\n \"strikethrough\": false,\n \"stringConditionType\": \"\",\n \"title\": \"\",\n \"trueText\": \"\",\n \"type\": \"\",\n \"typeface\": \"\",\n \"uppercase\": false,\n \"vAlignment\": \"\",\n \"width\": \"\",\n \"x\": \"\",\n \"y\": \"\"\n }\n ]\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/templates/:template_id/add_fields"
payload := strings.NewReader("{\n \"fields\": [\n {\n \"alignment\": \"\",\n \"autoCalculateMaxLength\": false,\n \"backgroundColor\": \"\",\n \"backgroundColorFieldName\": \"\",\n \"backgroundColorFieldRequired\": false,\n \"barcodeSymbology\": \"\",\n \"bold\": false,\n \"characterSpacing\": \"\",\n \"checkCharacter\": \"\",\n \"checkColor\": \"\",\n \"checkColorFieldName\": \"\",\n \"checkColorFieldRequired\": false,\n \"color\": \"\",\n \"colorFieldName\": \"\",\n \"colorFieldRequired\": false,\n \"comb\": false,\n \"combNumberOfCells\": \"\",\n \"combValueOffset\": \"\",\n \"combinedFieldFormat\": \"\",\n \"combinedFieldNames\": \"\",\n \"combinedFieldSeparator\": \"\",\n \"combinedFieldType\": \"\",\n \"condition\": \"\",\n \"currency\": false,\n \"dateTimeFormat\": \"\",\n \"decimalPlaces\": \"\",\n \"default\": \"\",\n \"description\": \"\",\n \"displayType\": \"\",\n \"exclusiveMaximum\": false,\n \"exclusiveMinimum\": false,\n \"falseText\": \"\",\n \"fontSize\": \"\",\n \"height\": \"\",\n \"hidden\": false,\n \"id\": \"\",\n \"imageGravity\": \"\",\n \"imageScaleType\": \"\",\n \"includeTime\": false,\n \"integer\": false,\n \"invertBooleanCondition\": false,\n \"maxLength\": \"\",\n \"maximum\": \"\",\n \"metadata\": \"\",\n \"minLength\": \"\",\n \"minimum\": \"\",\n \"multiline\": false,\n \"multilineLines\": \"\",\n \"name\": \"\",\n \"numberConditionRangeExclusiveMax\": false,\n \"numberConditionRangeExclusiveMin\": false,\n \"numberConditionRangeMax\": \"\",\n \"numberConditionRangeMin\": \"\",\n \"numberConditionType\": \"\",\n \"opacity\": \"\",\n \"optionList\": \"\",\n \"overflow\": \"\",\n \"page\": \"\",\n \"placeholder\": \"\",\n \"qrcodeColor\": \"\",\n \"qrcodeColorFieldName\": \"\",\n \"qrcodeColorFieldRequired\": false,\n \"required\": false,\n \"rotation\": \"\",\n \"shapeBorderColor\": \"\",\n \"shapeBorderColorFieldName\": \"\",\n \"shapeBorderColorFieldRequired\": false,\n \"shapeBorderWidth\": \"\",\n \"shapeFillColor\": \"\",\n \"shapeFillColorFieldName\": \"\",\n \"shapeFillColorFieldRequired\": false,\n \"shapeType\": \"\",\n \"signatureAllowDraw\": false,\n \"signatureAllowType\": false,\n \"static\": false,\n \"strikethrough\": false,\n \"stringConditionType\": \"\",\n \"title\": \"\",\n \"trueText\": \"\",\n \"type\": \"\",\n \"typeface\": \"\",\n \"uppercase\": false,\n \"vAlignment\": \"\",\n \"width\": \"\",\n \"x\": \"\",\n \"y\": \"\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}PUT /baseUrl/templates/:template_id/add_fields HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2453
{
"fields": [
{
"alignment": "",
"autoCalculateMaxLength": false,
"backgroundColor": "",
"backgroundColorFieldName": "",
"backgroundColorFieldRequired": false,
"barcodeSymbology": "",
"bold": false,
"characterSpacing": "",
"checkCharacter": "",
"checkColor": "",
"checkColorFieldName": "",
"checkColorFieldRequired": false,
"color": "",
"colorFieldName": "",
"colorFieldRequired": false,
"comb": false,
"combNumberOfCells": "",
"combValueOffset": "",
"combinedFieldFormat": "",
"combinedFieldNames": "",
"combinedFieldSeparator": "",
"combinedFieldType": "",
"condition": "",
"currency": false,
"dateTimeFormat": "",
"decimalPlaces": "",
"default": "",
"description": "",
"displayType": "",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"falseText": "",
"fontSize": "",
"height": "",
"hidden": false,
"id": "",
"imageGravity": "",
"imageScaleType": "",
"includeTime": false,
"integer": false,
"invertBooleanCondition": false,
"maxLength": "",
"maximum": "",
"metadata": "",
"minLength": "",
"minimum": "",
"multiline": false,
"multilineLines": "",
"name": "",
"numberConditionRangeExclusiveMax": false,
"numberConditionRangeExclusiveMin": false,
"numberConditionRangeMax": "",
"numberConditionRangeMin": "",
"numberConditionType": "",
"opacity": "",
"optionList": "",
"overflow": "",
"page": "",
"placeholder": "",
"qrcodeColor": "",
"qrcodeColorFieldName": "",
"qrcodeColorFieldRequired": false,
"required": false,
"rotation": "",
"shapeBorderColor": "",
"shapeBorderColorFieldName": "",
"shapeBorderColorFieldRequired": false,
"shapeBorderWidth": "",
"shapeFillColor": "",
"shapeFillColorFieldName": "",
"shapeFillColorFieldRequired": false,
"shapeType": "",
"signatureAllowDraw": false,
"signatureAllowType": false,
"static": false,
"strikethrough": false,
"stringConditionType": "",
"title": "",
"trueText": "",
"type": "",
"typeface": "",
"uppercase": false,
"vAlignment": "",
"width": "",
"x": "",
"y": ""
}
]
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/templates/:template_id/add_fields")
.setHeader("content-type", "application/json")
.setBody("{\n \"fields\": [\n {\n \"alignment\": \"\",\n \"autoCalculateMaxLength\": false,\n \"backgroundColor\": \"\",\n \"backgroundColorFieldName\": \"\",\n \"backgroundColorFieldRequired\": false,\n \"barcodeSymbology\": \"\",\n \"bold\": false,\n \"characterSpacing\": \"\",\n \"checkCharacter\": \"\",\n \"checkColor\": \"\",\n \"checkColorFieldName\": \"\",\n \"checkColorFieldRequired\": false,\n \"color\": \"\",\n \"colorFieldName\": \"\",\n \"colorFieldRequired\": false,\n \"comb\": false,\n \"combNumberOfCells\": \"\",\n \"combValueOffset\": \"\",\n \"combinedFieldFormat\": \"\",\n \"combinedFieldNames\": \"\",\n \"combinedFieldSeparator\": \"\",\n \"combinedFieldType\": \"\",\n \"condition\": \"\",\n \"currency\": false,\n \"dateTimeFormat\": \"\",\n \"decimalPlaces\": \"\",\n \"default\": \"\",\n \"description\": \"\",\n \"displayType\": \"\",\n \"exclusiveMaximum\": false,\n \"exclusiveMinimum\": false,\n \"falseText\": \"\",\n \"fontSize\": \"\",\n \"height\": \"\",\n \"hidden\": false,\n \"id\": \"\",\n \"imageGravity\": \"\",\n \"imageScaleType\": \"\",\n \"includeTime\": false,\n \"integer\": false,\n \"invertBooleanCondition\": false,\n \"maxLength\": \"\",\n \"maximum\": \"\",\n \"metadata\": \"\",\n \"minLength\": \"\",\n \"minimum\": \"\",\n \"multiline\": false,\n \"multilineLines\": \"\",\n \"name\": \"\",\n \"numberConditionRangeExclusiveMax\": false,\n \"numberConditionRangeExclusiveMin\": false,\n \"numberConditionRangeMax\": \"\",\n \"numberConditionRangeMin\": \"\",\n \"numberConditionType\": \"\",\n \"opacity\": \"\",\n \"optionList\": \"\",\n \"overflow\": \"\",\n \"page\": \"\",\n \"placeholder\": \"\",\n \"qrcodeColor\": \"\",\n \"qrcodeColorFieldName\": \"\",\n \"qrcodeColorFieldRequired\": false,\n \"required\": false,\n \"rotation\": \"\",\n \"shapeBorderColor\": \"\",\n \"shapeBorderColorFieldName\": \"\",\n \"shapeBorderColorFieldRequired\": false,\n \"shapeBorderWidth\": \"\",\n \"shapeFillColor\": \"\",\n \"shapeFillColorFieldName\": \"\",\n \"shapeFillColorFieldRequired\": false,\n \"shapeType\": \"\",\n \"signatureAllowDraw\": false,\n \"signatureAllowType\": false,\n \"static\": false,\n \"strikethrough\": false,\n \"stringConditionType\": \"\",\n \"title\": \"\",\n \"trueText\": \"\",\n \"type\": \"\",\n \"typeface\": \"\",\n \"uppercase\": false,\n \"vAlignment\": \"\",\n \"width\": \"\",\n \"x\": \"\",\n \"y\": \"\"\n }\n ]\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/templates/:template_id/add_fields"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"fields\": [\n {\n \"alignment\": \"\",\n \"autoCalculateMaxLength\": false,\n \"backgroundColor\": \"\",\n \"backgroundColorFieldName\": \"\",\n \"backgroundColorFieldRequired\": false,\n \"barcodeSymbology\": \"\",\n \"bold\": false,\n \"characterSpacing\": \"\",\n \"checkCharacter\": \"\",\n \"checkColor\": \"\",\n \"checkColorFieldName\": \"\",\n \"checkColorFieldRequired\": false,\n \"color\": \"\",\n \"colorFieldName\": \"\",\n \"colorFieldRequired\": false,\n \"comb\": false,\n \"combNumberOfCells\": \"\",\n \"combValueOffset\": \"\",\n \"combinedFieldFormat\": \"\",\n \"combinedFieldNames\": \"\",\n \"combinedFieldSeparator\": \"\",\n \"combinedFieldType\": \"\",\n \"condition\": \"\",\n \"currency\": false,\n \"dateTimeFormat\": \"\",\n \"decimalPlaces\": \"\",\n \"default\": \"\",\n \"description\": \"\",\n \"displayType\": \"\",\n \"exclusiveMaximum\": false,\n \"exclusiveMinimum\": false,\n \"falseText\": \"\",\n \"fontSize\": \"\",\n \"height\": \"\",\n \"hidden\": false,\n \"id\": \"\",\n \"imageGravity\": \"\",\n \"imageScaleType\": \"\",\n \"includeTime\": false,\n \"integer\": false,\n \"invertBooleanCondition\": false,\n \"maxLength\": \"\",\n \"maximum\": \"\",\n \"metadata\": \"\",\n \"minLength\": \"\",\n \"minimum\": \"\",\n \"multiline\": false,\n \"multilineLines\": \"\",\n \"name\": \"\",\n \"numberConditionRangeExclusiveMax\": false,\n \"numberConditionRangeExclusiveMin\": false,\n \"numberConditionRangeMax\": \"\",\n \"numberConditionRangeMin\": \"\",\n \"numberConditionType\": \"\",\n \"opacity\": \"\",\n \"optionList\": \"\",\n \"overflow\": \"\",\n \"page\": \"\",\n \"placeholder\": \"\",\n \"qrcodeColor\": \"\",\n \"qrcodeColorFieldName\": \"\",\n \"qrcodeColorFieldRequired\": false,\n \"required\": false,\n \"rotation\": \"\",\n \"shapeBorderColor\": \"\",\n \"shapeBorderColorFieldName\": \"\",\n \"shapeBorderColorFieldRequired\": false,\n \"shapeBorderWidth\": \"\",\n \"shapeFillColor\": \"\",\n \"shapeFillColorFieldName\": \"\",\n \"shapeFillColorFieldRequired\": false,\n \"shapeType\": \"\",\n \"signatureAllowDraw\": false,\n \"signatureAllowType\": false,\n \"static\": false,\n \"strikethrough\": false,\n \"stringConditionType\": \"\",\n \"title\": \"\",\n \"trueText\": \"\",\n \"type\": \"\",\n \"typeface\": \"\",\n \"uppercase\": false,\n \"vAlignment\": \"\",\n \"width\": \"\",\n \"x\": \"\",\n \"y\": \"\"\n }\n ]\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"fields\": [\n {\n \"alignment\": \"\",\n \"autoCalculateMaxLength\": false,\n \"backgroundColor\": \"\",\n \"backgroundColorFieldName\": \"\",\n \"backgroundColorFieldRequired\": false,\n \"barcodeSymbology\": \"\",\n \"bold\": false,\n \"characterSpacing\": \"\",\n \"checkCharacter\": \"\",\n \"checkColor\": \"\",\n \"checkColorFieldName\": \"\",\n \"checkColorFieldRequired\": false,\n \"color\": \"\",\n \"colorFieldName\": \"\",\n \"colorFieldRequired\": false,\n \"comb\": false,\n \"combNumberOfCells\": \"\",\n \"combValueOffset\": \"\",\n \"combinedFieldFormat\": \"\",\n \"combinedFieldNames\": \"\",\n \"combinedFieldSeparator\": \"\",\n \"combinedFieldType\": \"\",\n \"condition\": \"\",\n \"currency\": false,\n \"dateTimeFormat\": \"\",\n \"decimalPlaces\": \"\",\n \"default\": \"\",\n \"description\": \"\",\n \"displayType\": \"\",\n \"exclusiveMaximum\": false,\n \"exclusiveMinimum\": false,\n \"falseText\": \"\",\n \"fontSize\": \"\",\n \"height\": \"\",\n \"hidden\": false,\n \"id\": \"\",\n \"imageGravity\": \"\",\n \"imageScaleType\": \"\",\n \"includeTime\": false,\n \"integer\": false,\n \"invertBooleanCondition\": false,\n \"maxLength\": \"\",\n \"maximum\": \"\",\n \"metadata\": \"\",\n \"minLength\": \"\",\n \"minimum\": \"\",\n \"multiline\": false,\n \"multilineLines\": \"\",\n \"name\": \"\",\n \"numberConditionRangeExclusiveMax\": false,\n \"numberConditionRangeExclusiveMin\": false,\n \"numberConditionRangeMax\": \"\",\n \"numberConditionRangeMin\": \"\",\n \"numberConditionType\": \"\",\n \"opacity\": \"\",\n \"optionList\": \"\",\n \"overflow\": \"\",\n \"page\": \"\",\n \"placeholder\": \"\",\n \"qrcodeColor\": \"\",\n \"qrcodeColorFieldName\": \"\",\n \"qrcodeColorFieldRequired\": false,\n \"required\": false,\n \"rotation\": \"\",\n \"shapeBorderColor\": \"\",\n \"shapeBorderColorFieldName\": \"\",\n \"shapeBorderColorFieldRequired\": false,\n \"shapeBorderWidth\": \"\",\n \"shapeFillColor\": \"\",\n \"shapeFillColorFieldName\": \"\",\n \"shapeFillColorFieldRequired\": false,\n \"shapeType\": \"\",\n \"signatureAllowDraw\": false,\n \"signatureAllowType\": false,\n \"static\": false,\n \"strikethrough\": false,\n \"stringConditionType\": \"\",\n \"title\": \"\",\n \"trueText\": \"\",\n \"type\": \"\",\n \"typeface\": \"\",\n \"uppercase\": false,\n \"vAlignment\": \"\",\n \"width\": \"\",\n \"x\": \"\",\n \"y\": \"\"\n }\n ]\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/templates/:template_id/add_fields")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.put("{{baseUrl}}/templates/:template_id/add_fields")
.header("content-type", "application/json")
.body("{\n \"fields\": [\n {\n \"alignment\": \"\",\n \"autoCalculateMaxLength\": false,\n \"backgroundColor\": \"\",\n \"backgroundColorFieldName\": \"\",\n \"backgroundColorFieldRequired\": false,\n \"barcodeSymbology\": \"\",\n \"bold\": false,\n \"characterSpacing\": \"\",\n \"checkCharacter\": \"\",\n \"checkColor\": \"\",\n \"checkColorFieldName\": \"\",\n \"checkColorFieldRequired\": false,\n \"color\": \"\",\n \"colorFieldName\": \"\",\n \"colorFieldRequired\": false,\n \"comb\": false,\n \"combNumberOfCells\": \"\",\n \"combValueOffset\": \"\",\n \"combinedFieldFormat\": \"\",\n \"combinedFieldNames\": \"\",\n \"combinedFieldSeparator\": \"\",\n \"combinedFieldType\": \"\",\n \"condition\": \"\",\n \"currency\": false,\n \"dateTimeFormat\": \"\",\n \"decimalPlaces\": \"\",\n \"default\": \"\",\n \"description\": \"\",\n \"displayType\": \"\",\n \"exclusiveMaximum\": false,\n \"exclusiveMinimum\": false,\n \"falseText\": \"\",\n \"fontSize\": \"\",\n \"height\": \"\",\n \"hidden\": false,\n \"id\": \"\",\n \"imageGravity\": \"\",\n \"imageScaleType\": \"\",\n \"includeTime\": false,\n \"integer\": false,\n \"invertBooleanCondition\": false,\n \"maxLength\": \"\",\n \"maximum\": \"\",\n \"metadata\": \"\",\n \"minLength\": \"\",\n \"minimum\": \"\",\n \"multiline\": false,\n \"multilineLines\": \"\",\n \"name\": \"\",\n \"numberConditionRangeExclusiveMax\": false,\n \"numberConditionRangeExclusiveMin\": false,\n \"numberConditionRangeMax\": \"\",\n \"numberConditionRangeMin\": \"\",\n \"numberConditionType\": \"\",\n \"opacity\": \"\",\n \"optionList\": \"\",\n \"overflow\": \"\",\n \"page\": \"\",\n \"placeholder\": \"\",\n \"qrcodeColor\": \"\",\n \"qrcodeColorFieldName\": \"\",\n \"qrcodeColorFieldRequired\": false,\n \"required\": false,\n \"rotation\": \"\",\n \"shapeBorderColor\": \"\",\n \"shapeBorderColorFieldName\": \"\",\n \"shapeBorderColorFieldRequired\": false,\n \"shapeBorderWidth\": \"\",\n \"shapeFillColor\": \"\",\n \"shapeFillColorFieldName\": \"\",\n \"shapeFillColorFieldRequired\": false,\n \"shapeType\": \"\",\n \"signatureAllowDraw\": false,\n \"signatureAllowType\": false,\n \"static\": false,\n \"strikethrough\": false,\n \"stringConditionType\": \"\",\n \"title\": \"\",\n \"trueText\": \"\",\n \"type\": \"\",\n \"typeface\": \"\",\n \"uppercase\": false,\n \"vAlignment\": \"\",\n \"width\": \"\",\n \"x\": \"\",\n \"y\": \"\"\n }\n ]\n}")
.asString(); const data = JSON.stringify({
fields: [
{
alignment: '',
autoCalculateMaxLength: false,
backgroundColor: '',
backgroundColorFieldName: '',
backgroundColorFieldRequired: false,
barcodeSymbology: '',
bold: false,
characterSpacing: '',
checkCharacter: '',
checkColor: '',
checkColorFieldName: '',
checkColorFieldRequired: false,
color: '',
colorFieldName: '',
colorFieldRequired: false,
comb: false,
combNumberOfCells: '',
combValueOffset: '',
combinedFieldFormat: '',
combinedFieldNames: '',
combinedFieldSeparator: '',
combinedFieldType: '',
condition: '',
currency: false,
dateTimeFormat: '',
decimalPlaces: '',
default: '',
description: '',
displayType: '',
exclusiveMaximum: false,
exclusiveMinimum: false,
falseText: '',
fontSize: '',
height: '',
hidden: false,
id: '',
imageGravity: '',
imageScaleType: '',
includeTime: false,
integer: false,
invertBooleanCondition: false,
maxLength: '',
maximum: '',
metadata: '',
minLength: '',
minimum: '',
multiline: false,
multilineLines: '',
name: '',
numberConditionRangeExclusiveMax: false,
numberConditionRangeExclusiveMin: false,
numberConditionRangeMax: '',
numberConditionRangeMin: '',
numberConditionType: '',
opacity: '',
optionList: '',
overflow: '',
page: '',
placeholder: '',
qrcodeColor: '',
qrcodeColorFieldName: '',
qrcodeColorFieldRequired: false,
required: false,
rotation: '',
shapeBorderColor: '',
shapeBorderColorFieldName: '',
shapeBorderColorFieldRequired: false,
shapeBorderWidth: '',
shapeFillColor: '',
shapeFillColorFieldName: '',
shapeFillColorFieldRequired: false,
shapeType: '',
signatureAllowDraw: false,
signatureAllowType: false,
static: false,
strikethrough: false,
stringConditionType: '',
title: '',
trueText: '',
type: '',
typeface: '',
uppercase: false,
vAlignment: '',
width: '',
x: '',
y: ''
}
]
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/templates/:template_id/add_fields');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/templates/:template_id/add_fields',
headers: {'content-type': 'application/json'},
data: {
fields: [
{
alignment: '',
autoCalculateMaxLength: false,
backgroundColor: '',
backgroundColorFieldName: '',
backgroundColorFieldRequired: false,
barcodeSymbology: '',
bold: false,
characterSpacing: '',
checkCharacter: '',
checkColor: '',
checkColorFieldName: '',
checkColorFieldRequired: false,
color: '',
colorFieldName: '',
colorFieldRequired: false,
comb: false,
combNumberOfCells: '',
combValueOffset: '',
combinedFieldFormat: '',
combinedFieldNames: '',
combinedFieldSeparator: '',
combinedFieldType: '',
condition: '',
currency: false,
dateTimeFormat: '',
decimalPlaces: '',
default: '',
description: '',
displayType: '',
exclusiveMaximum: false,
exclusiveMinimum: false,
falseText: '',
fontSize: '',
height: '',
hidden: false,
id: '',
imageGravity: '',
imageScaleType: '',
includeTime: false,
integer: false,
invertBooleanCondition: false,
maxLength: '',
maximum: '',
metadata: '',
minLength: '',
minimum: '',
multiline: false,
multilineLines: '',
name: '',
numberConditionRangeExclusiveMax: false,
numberConditionRangeExclusiveMin: false,
numberConditionRangeMax: '',
numberConditionRangeMin: '',
numberConditionType: '',
opacity: '',
optionList: '',
overflow: '',
page: '',
placeholder: '',
qrcodeColor: '',
qrcodeColorFieldName: '',
qrcodeColorFieldRequired: false,
required: false,
rotation: '',
shapeBorderColor: '',
shapeBorderColorFieldName: '',
shapeBorderColorFieldRequired: false,
shapeBorderWidth: '',
shapeFillColor: '',
shapeFillColorFieldName: '',
shapeFillColorFieldRequired: false,
shapeType: '',
signatureAllowDraw: false,
signatureAllowType: false,
static: false,
strikethrough: false,
stringConditionType: '',
title: '',
trueText: '',
type: '',
typeface: '',
uppercase: false,
vAlignment: '',
width: '',
x: '',
y: ''
}
]
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/templates/:template_id/add_fields';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"fields":[{"alignment":"","autoCalculateMaxLength":false,"backgroundColor":"","backgroundColorFieldName":"","backgroundColorFieldRequired":false,"barcodeSymbology":"","bold":false,"characterSpacing":"","checkCharacter":"","checkColor":"","checkColorFieldName":"","checkColorFieldRequired":false,"color":"","colorFieldName":"","colorFieldRequired":false,"comb":false,"combNumberOfCells":"","combValueOffset":"","combinedFieldFormat":"","combinedFieldNames":"","combinedFieldSeparator":"","combinedFieldType":"","condition":"","currency":false,"dateTimeFormat":"","decimalPlaces":"","default":"","description":"","displayType":"","exclusiveMaximum":false,"exclusiveMinimum":false,"falseText":"","fontSize":"","height":"","hidden":false,"id":"","imageGravity":"","imageScaleType":"","includeTime":false,"integer":false,"invertBooleanCondition":false,"maxLength":"","maximum":"","metadata":"","minLength":"","minimum":"","multiline":false,"multilineLines":"","name":"","numberConditionRangeExclusiveMax":false,"numberConditionRangeExclusiveMin":false,"numberConditionRangeMax":"","numberConditionRangeMin":"","numberConditionType":"","opacity":"","optionList":"","overflow":"","page":"","placeholder":"","qrcodeColor":"","qrcodeColorFieldName":"","qrcodeColorFieldRequired":false,"required":false,"rotation":"","shapeBorderColor":"","shapeBorderColorFieldName":"","shapeBorderColorFieldRequired":false,"shapeBorderWidth":"","shapeFillColor":"","shapeFillColorFieldName":"","shapeFillColorFieldRequired":false,"shapeType":"","signatureAllowDraw":false,"signatureAllowType":false,"static":false,"strikethrough":false,"stringConditionType":"","title":"","trueText":"","type":"","typeface":"","uppercase":false,"vAlignment":"","width":"","x":"","y":""}]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/templates/:template_id/add_fields',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "fields": [\n {\n "alignment": "",\n "autoCalculateMaxLength": false,\n "backgroundColor": "",\n "backgroundColorFieldName": "",\n "backgroundColorFieldRequired": false,\n "barcodeSymbology": "",\n "bold": false,\n "characterSpacing": "",\n "checkCharacter": "",\n "checkColor": "",\n "checkColorFieldName": "",\n "checkColorFieldRequired": false,\n "color": "",\n "colorFieldName": "",\n "colorFieldRequired": false,\n "comb": false,\n "combNumberOfCells": "",\n "combValueOffset": "",\n "combinedFieldFormat": "",\n "combinedFieldNames": "",\n "combinedFieldSeparator": "",\n "combinedFieldType": "",\n "condition": "",\n "currency": false,\n "dateTimeFormat": "",\n "decimalPlaces": "",\n "default": "",\n "description": "",\n "displayType": "",\n "exclusiveMaximum": false,\n "exclusiveMinimum": false,\n "falseText": "",\n "fontSize": "",\n "height": "",\n "hidden": false,\n "id": "",\n "imageGravity": "",\n "imageScaleType": "",\n "includeTime": false,\n "integer": false,\n "invertBooleanCondition": false,\n "maxLength": "",\n "maximum": "",\n "metadata": "",\n "minLength": "",\n "minimum": "",\n "multiline": false,\n "multilineLines": "",\n "name": "",\n "numberConditionRangeExclusiveMax": false,\n "numberConditionRangeExclusiveMin": false,\n "numberConditionRangeMax": "",\n "numberConditionRangeMin": "",\n "numberConditionType": "",\n "opacity": "",\n "optionList": "",\n "overflow": "",\n "page": "",\n "placeholder": "",\n "qrcodeColor": "",\n "qrcodeColorFieldName": "",\n "qrcodeColorFieldRequired": false,\n "required": false,\n "rotation": "",\n "shapeBorderColor": "",\n "shapeBorderColorFieldName": "",\n "shapeBorderColorFieldRequired": false,\n "shapeBorderWidth": "",\n "shapeFillColor": "",\n "shapeFillColorFieldName": "",\n "shapeFillColorFieldRequired": false,\n "shapeType": "",\n "signatureAllowDraw": false,\n "signatureAllowType": false,\n "static": false,\n "strikethrough": false,\n "stringConditionType": "",\n "title": "",\n "trueText": "",\n "type": "",\n "typeface": "",\n "uppercase": false,\n "vAlignment": "",\n "width": "",\n "x": "",\n "y": ""\n }\n ]\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"fields\": [\n {\n \"alignment\": \"\",\n \"autoCalculateMaxLength\": false,\n \"backgroundColor\": \"\",\n \"backgroundColorFieldName\": \"\",\n \"backgroundColorFieldRequired\": false,\n \"barcodeSymbology\": \"\",\n \"bold\": false,\n \"characterSpacing\": \"\",\n \"checkCharacter\": \"\",\n \"checkColor\": \"\",\n \"checkColorFieldName\": \"\",\n \"checkColorFieldRequired\": false,\n \"color\": \"\",\n \"colorFieldName\": \"\",\n \"colorFieldRequired\": false,\n \"comb\": false,\n \"combNumberOfCells\": \"\",\n \"combValueOffset\": \"\",\n \"combinedFieldFormat\": \"\",\n \"combinedFieldNames\": \"\",\n \"combinedFieldSeparator\": \"\",\n \"combinedFieldType\": \"\",\n \"condition\": \"\",\n \"currency\": false,\n \"dateTimeFormat\": \"\",\n \"decimalPlaces\": \"\",\n \"default\": \"\",\n \"description\": \"\",\n \"displayType\": \"\",\n \"exclusiveMaximum\": false,\n \"exclusiveMinimum\": false,\n \"falseText\": \"\",\n \"fontSize\": \"\",\n \"height\": \"\",\n \"hidden\": false,\n \"id\": \"\",\n \"imageGravity\": \"\",\n \"imageScaleType\": \"\",\n \"includeTime\": false,\n \"integer\": false,\n \"invertBooleanCondition\": false,\n \"maxLength\": \"\",\n \"maximum\": \"\",\n \"metadata\": \"\",\n \"minLength\": \"\",\n \"minimum\": \"\",\n \"multiline\": false,\n \"multilineLines\": \"\",\n \"name\": \"\",\n \"numberConditionRangeExclusiveMax\": false,\n \"numberConditionRangeExclusiveMin\": false,\n \"numberConditionRangeMax\": \"\",\n \"numberConditionRangeMin\": \"\",\n \"numberConditionType\": \"\",\n \"opacity\": \"\",\n \"optionList\": \"\",\n \"overflow\": \"\",\n \"page\": \"\",\n \"placeholder\": \"\",\n \"qrcodeColor\": \"\",\n \"qrcodeColorFieldName\": \"\",\n \"qrcodeColorFieldRequired\": false,\n \"required\": false,\n \"rotation\": \"\",\n \"shapeBorderColor\": \"\",\n \"shapeBorderColorFieldName\": \"\",\n \"shapeBorderColorFieldRequired\": false,\n \"shapeBorderWidth\": \"\",\n \"shapeFillColor\": \"\",\n \"shapeFillColorFieldName\": \"\",\n \"shapeFillColorFieldRequired\": false,\n \"shapeType\": \"\",\n \"signatureAllowDraw\": false,\n \"signatureAllowType\": false,\n \"static\": false,\n \"strikethrough\": false,\n \"stringConditionType\": \"\",\n \"title\": \"\",\n \"trueText\": \"\",\n \"type\": \"\",\n \"typeface\": \"\",\n \"uppercase\": false,\n \"vAlignment\": \"\",\n \"width\": \"\",\n \"x\": \"\",\n \"y\": \"\"\n }\n ]\n}")
val request = Request.Builder()
.url("{{baseUrl}}/templates/:template_id/add_fields")
.put(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/templates/:template_id/add_fields',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
fields: [
{
alignment: '',
autoCalculateMaxLength: false,
backgroundColor: '',
backgroundColorFieldName: '',
backgroundColorFieldRequired: false,
barcodeSymbology: '',
bold: false,
characterSpacing: '',
checkCharacter: '',
checkColor: '',
checkColorFieldName: '',
checkColorFieldRequired: false,
color: '',
colorFieldName: '',
colorFieldRequired: false,
comb: false,
combNumberOfCells: '',
combValueOffset: '',
combinedFieldFormat: '',
combinedFieldNames: '',
combinedFieldSeparator: '',
combinedFieldType: '',
condition: '',
currency: false,
dateTimeFormat: '',
decimalPlaces: '',
default: '',
description: '',
displayType: '',
exclusiveMaximum: false,
exclusiveMinimum: false,
falseText: '',
fontSize: '',
height: '',
hidden: false,
id: '',
imageGravity: '',
imageScaleType: '',
includeTime: false,
integer: false,
invertBooleanCondition: false,
maxLength: '',
maximum: '',
metadata: '',
minLength: '',
minimum: '',
multiline: false,
multilineLines: '',
name: '',
numberConditionRangeExclusiveMax: false,
numberConditionRangeExclusiveMin: false,
numberConditionRangeMax: '',
numberConditionRangeMin: '',
numberConditionType: '',
opacity: '',
optionList: '',
overflow: '',
page: '',
placeholder: '',
qrcodeColor: '',
qrcodeColorFieldName: '',
qrcodeColorFieldRequired: false,
required: false,
rotation: '',
shapeBorderColor: '',
shapeBorderColorFieldName: '',
shapeBorderColorFieldRequired: false,
shapeBorderWidth: '',
shapeFillColor: '',
shapeFillColorFieldName: '',
shapeFillColorFieldRequired: false,
shapeType: '',
signatureAllowDraw: false,
signatureAllowType: false,
static: false,
strikethrough: false,
stringConditionType: '',
title: '',
trueText: '',
type: '',
typeface: '',
uppercase: false,
vAlignment: '',
width: '',
x: '',
y: ''
}
]
}));
req.end();const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/templates/:template_id/add_fields',
headers: {'content-type': 'application/json'},
body: {
fields: [
{
alignment: '',
autoCalculateMaxLength: false,
backgroundColor: '',
backgroundColorFieldName: '',
backgroundColorFieldRequired: false,
barcodeSymbology: '',
bold: false,
characterSpacing: '',
checkCharacter: '',
checkColor: '',
checkColorFieldName: '',
checkColorFieldRequired: false,
color: '',
colorFieldName: '',
colorFieldRequired: false,
comb: false,
combNumberOfCells: '',
combValueOffset: '',
combinedFieldFormat: '',
combinedFieldNames: '',
combinedFieldSeparator: '',
combinedFieldType: '',
condition: '',
currency: false,
dateTimeFormat: '',
decimalPlaces: '',
default: '',
description: '',
displayType: '',
exclusiveMaximum: false,
exclusiveMinimum: false,
falseText: '',
fontSize: '',
height: '',
hidden: false,
id: '',
imageGravity: '',
imageScaleType: '',
includeTime: false,
integer: false,
invertBooleanCondition: false,
maxLength: '',
maximum: '',
metadata: '',
minLength: '',
minimum: '',
multiline: false,
multilineLines: '',
name: '',
numberConditionRangeExclusiveMax: false,
numberConditionRangeExclusiveMin: false,
numberConditionRangeMax: '',
numberConditionRangeMin: '',
numberConditionType: '',
opacity: '',
optionList: '',
overflow: '',
page: '',
placeholder: '',
qrcodeColor: '',
qrcodeColorFieldName: '',
qrcodeColorFieldRequired: false,
required: false,
rotation: '',
shapeBorderColor: '',
shapeBorderColorFieldName: '',
shapeBorderColorFieldRequired: false,
shapeBorderWidth: '',
shapeFillColor: '',
shapeFillColorFieldName: '',
shapeFillColorFieldRequired: false,
shapeType: '',
signatureAllowDraw: false,
signatureAllowType: false,
static: false,
strikethrough: false,
stringConditionType: '',
title: '',
trueText: '',
type: '',
typeface: '',
uppercase: false,
vAlignment: '',
width: '',
x: '',
y: ''
}
]
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/templates/:template_id/add_fields');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
fields: [
{
alignment: '',
autoCalculateMaxLength: false,
backgroundColor: '',
backgroundColorFieldName: '',
backgroundColorFieldRequired: false,
barcodeSymbology: '',
bold: false,
characterSpacing: '',
checkCharacter: '',
checkColor: '',
checkColorFieldName: '',
checkColorFieldRequired: false,
color: '',
colorFieldName: '',
colorFieldRequired: false,
comb: false,
combNumberOfCells: '',
combValueOffset: '',
combinedFieldFormat: '',
combinedFieldNames: '',
combinedFieldSeparator: '',
combinedFieldType: '',
condition: '',
currency: false,
dateTimeFormat: '',
decimalPlaces: '',
default: '',
description: '',
displayType: '',
exclusiveMaximum: false,
exclusiveMinimum: false,
falseText: '',
fontSize: '',
height: '',
hidden: false,
id: '',
imageGravity: '',
imageScaleType: '',
includeTime: false,
integer: false,
invertBooleanCondition: false,
maxLength: '',
maximum: '',
metadata: '',
minLength: '',
minimum: '',
multiline: false,
multilineLines: '',
name: '',
numberConditionRangeExclusiveMax: false,
numberConditionRangeExclusiveMin: false,
numberConditionRangeMax: '',
numberConditionRangeMin: '',
numberConditionType: '',
opacity: '',
optionList: '',
overflow: '',
page: '',
placeholder: '',
qrcodeColor: '',
qrcodeColorFieldName: '',
qrcodeColorFieldRequired: false,
required: false,
rotation: '',
shapeBorderColor: '',
shapeBorderColorFieldName: '',
shapeBorderColorFieldRequired: false,
shapeBorderWidth: '',
shapeFillColor: '',
shapeFillColorFieldName: '',
shapeFillColorFieldRequired: false,
shapeType: '',
signatureAllowDraw: false,
signatureAllowType: false,
static: false,
strikethrough: false,
stringConditionType: '',
title: '',
trueText: '',
type: '',
typeface: '',
uppercase: false,
vAlignment: '',
width: '',
x: '',
y: ''
}
]
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'PUT',
url: '{{baseUrl}}/templates/:template_id/add_fields',
headers: {'content-type': 'application/json'},
data: {
fields: [
{
alignment: '',
autoCalculateMaxLength: false,
backgroundColor: '',
backgroundColorFieldName: '',
backgroundColorFieldRequired: false,
barcodeSymbology: '',
bold: false,
characterSpacing: '',
checkCharacter: '',
checkColor: '',
checkColorFieldName: '',
checkColorFieldRequired: false,
color: '',
colorFieldName: '',
colorFieldRequired: false,
comb: false,
combNumberOfCells: '',
combValueOffset: '',
combinedFieldFormat: '',
combinedFieldNames: '',
combinedFieldSeparator: '',
combinedFieldType: '',
condition: '',
currency: false,
dateTimeFormat: '',
decimalPlaces: '',
default: '',
description: '',
displayType: '',
exclusiveMaximum: false,
exclusiveMinimum: false,
falseText: '',
fontSize: '',
height: '',
hidden: false,
id: '',
imageGravity: '',
imageScaleType: '',
includeTime: false,
integer: false,
invertBooleanCondition: false,
maxLength: '',
maximum: '',
metadata: '',
minLength: '',
minimum: '',
multiline: false,
multilineLines: '',
name: '',
numberConditionRangeExclusiveMax: false,
numberConditionRangeExclusiveMin: false,
numberConditionRangeMax: '',
numberConditionRangeMin: '',
numberConditionType: '',
opacity: '',
optionList: '',
overflow: '',
page: '',
placeholder: '',
qrcodeColor: '',
qrcodeColorFieldName: '',
qrcodeColorFieldRequired: false,
required: false,
rotation: '',
shapeBorderColor: '',
shapeBorderColorFieldName: '',
shapeBorderColorFieldRequired: false,
shapeBorderWidth: '',
shapeFillColor: '',
shapeFillColorFieldName: '',
shapeFillColorFieldRequired: false,
shapeType: '',
signatureAllowDraw: false,
signatureAllowType: false,
static: false,
strikethrough: false,
stringConditionType: '',
title: '',
trueText: '',
type: '',
typeface: '',
uppercase: false,
vAlignment: '',
width: '',
x: '',
y: ''
}
]
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/templates/:template_id/add_fields';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"fields":[{"alignment":"","autoCalculateMaxLength":false,"backgroundColor":"","backgroundColorFieldName":"","backgroundColorFieldRequired":false,"barcodeSymbology":"","bold":false,"characterSpacing":"","checkCharacter":"","checkColor":"","checkColorFieldName":"","checkColorFieldRequired":false,"color":"","colorFieldName":"","colorFieldRequired":false,"comb":false,"combNumberOfCells":"","combValueOffset":"","combinedFieldFormat":"","combinedFieldNames":"","combinedFieldSeparator":"","combinedFieldType":"","condition":"","currency":false,"dateTimeFormat":"","decimalPlaces":"","default":"","description":"","displayType":"","exclusiveMaximum":false,"exclusiveMinimum":false,"falseText":"","fontSize":"","height":"","hidden":false,"id":"","imageGravity":"","imageScaleType":"","includeTime":false,"integer":false,"invertBooleanCondition":false,"maxLength":"","maximum":"","metadata":"","minLength":"","minimum":"","multiline":false,"multilineLines":"","name":"","numberConditionRangeExclusiveMax":false,"numberConditionRangeExclusiveMin":false,"numberConditionRangeMax":"","numberConditionRangeMin":"","numberConditionType":"","opacity":"","optionList":"","overflow":"","page":"","placeholder":"","qrcodeColor":"","qrcodeColorFieldName":"","qrcodeColorFieldRequired":false,"required":false,"rotation":"","shapeBorderColor":"","shapeBorderColorFieldName":"","shapeBorderColorFieldRequired":false,"shapeBorderWidth":"","shapeFillColor":"","shapeFillColorFieldName":"","shapeFillColorFieldRequired":false,"shapeType":"","signatureAllowDraw":false,"signatureAllowType":false,"static":false,"strikethrough":false,"stringConditionType":"","title":"","trueText":"","type":"","typeface":"","uppercase":false,"vAlignment":"","width":"","x":"","y":""}]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"fields": @[ @{ @"alignment": @"", @"autoCalculateMaxLength": @NO, @"backgroundColor": @"", @"backgroundColorFieldName": @"", @"backgroundColorFieldRequired": @NO, @"barcodeSymbology": @"", @"bold": @NO, @"characterSpacing": @"", @"checkCharacter": @"", @"checkColor": @"", @"checkColorFieldName": @"", @"checkColorFieldRequired": @NO, @"color": @"", @"colorFieldName": @"", @"colorFieldRequired": @NO, @"comb": @NO, @"combNumberOfCells": @"", @"combValueOffset": @"", @"combinedFieldFormat": @"", @"combinedFieldNames": @"", @"combinedFieldSeparator": @"", @"combinedFieldType": @"", @"condition": @"", @"currency": @NO, @"dateTimeFormat": @"", @"decimalPlaces": @"", @"default": @"", @"description": @"", @"displayType": @"", @"exclusiveMaximum": @NO, @"exclusiveMinimum": @NO, @"falseText": @"", @"fontSize": @"", @"height": @"", @"hidden": @NO, @"id": @"", @"imageGravity": @"", @"imageScaleType": @"", @"includeTime": @NO, @"integer": @NO, @"invertBooleanCondition": @NO, @"maxLength": @"", @"maximum": @"", @"metadata": @"", @"minLength": @"", @"minimum": @"", @"multiline": @NO, @"multilineLines": @"", @"name": @"", @"numberConditionRangeExclusiveMax": @NO, @"numberConditionRangeExclusiveMin": @NO, @"numberConditionRangeMax": @"", @"numberConditionRangeMin": @"", @"numberConditionType": @"", @"opacity": @"", @"optionList": @"", @"overflow": @"", @"page": @"", @"placeholder": @"", @"qrcodeColor": @"", @"qrcodeColorFieldName": @"", @"qrcodeColorFieldRequired": @NO, @"required": @NO, @"rotation": @"", @"shapeBorderColor": @"", @"shapeBorderColorFieldName": @"", @"shapeBorderColorFieldRequired": @NO, @"shapeBorderWidth": @"", @"shapeFillColor": @"", @"shapeFillColorFieldName": @"", @"shapeFillColorFieldRequired": @NO, @"shapeType": @"", @"signatureAllowDraw": @NO, @"signatureAllowType": @NO, @"static": @NO, @"strikethrough": @NO, @"stringConditionType": @"", @"title": @"", @"trueText": @"", @"type": @"", @"typeface": @"", @"uppercase": @NO, @"vAlignment": @"", @"width": @"", @"x": @"", @"y": @"" } ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/templates/:template_id/add_fields"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/templates/:template_id/add_fields" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"fields\": [\n {\n \"alignment\": \"\",\n \"autoCalculateMaxLength\": false,\n \"backgroundColor\": \"\",\n \"backgroundColorFieldName\": \"\",\n \"backgroundColorFieldRequired\": false,\n \"barcodeSymbology\": \"\",\n \"bold\": false,\n \"characterSpacing\": \"\",\n \"checkCharacter\": \"\",\n \"checkColor\": \"\",\n \"checkColorFieldName\": \"\",\n \"checkColorFieldRequired\": false,\n \"color\": \"\",\n \"colorFieldName\": \"\",\n \"colorFieldRequired\": false,\n \"comb\": false,\n \"combNumberOfCells\": \"\",\n \"combValueOffset\": \"\",\n \"combinedFieldFormat\": \"\",\n \"combinedFieldNames\": \"\",\n \"combinedFieldSeparator\": \"\",\n \"combinedFieldType\": \"\",\n \"condition\": \"\",\n \"currency\": false,\n \"dateTimeFormat\": \"\",\n \"decimalPlaces\": \"\",\n \"default\": \"\",\n \"description\": \"\",\n \"displayType\": \"\",\n \"exclusiveMaximum\": false,\n \"exclusiveMinimum\": false,\n \"falseText\": \"\",\n \"fontSize\": \"\",\n \"height\": \"\",\n \"hidden\": false,\n \"id\": \"\",\n \"imageGravity\": \"\",\n \"imageScaleType\": \"\",\n \"includeTime\": false,\n \"integer\": false,\n \"invertBooleanCondition\": false,\n \"maxLength\": \"\",\n \"maximum\": \"\",\n \"metadata\": \"\",\n \"minLength\": \"\",\n \"minimum\": \"\",\n \"multiline\": false,\n \"multilineLines\": \"\",\n \"name\": \"\",\n \"numberConditionRangeExclusiveMax\": false,\n \"numberConditionRangeExclusiveMin\": false,\n \"numberConditionRangeMax\": \"\",\n \"numberConditionRangeMin\": \"\",\n \"numberConditionType\": \"\",\n \"opacity\": \"\",\n \"optionList\": \"\",\n \"overflow\": \"\",\n \"page\": \"\",\n \"placeholder\": \"\",\n \"qrcodeColor\": \"\",\n \"qrcodeColorFieldName\": \"\",\n \"qrcodeColorFieldRequired\": false,\n \"required\": false,\n \"rotation\": \"\",\n \"shapeBorderColor\": \"\",\n \"shapeBorderColorFieldName\": \"\",\n \"shapeBorderColorFieldRequired\": false,\n \"shapeBorderWidth\": \"\",\n \"shapeFillColor\": \"\",\n \"shapeFillColorFieldName\": \"\",\n \"shapeFillColorFieldRequired\": false,\n \"shapeType\": \"\",\n \"signatureAllowDraw\": false,\n \"signatureAllowType\": false,\n \"static\": false,\n \"strikethrough\": false,\n \"stringConditionType\": \"\",\n \"title\": \"\",\n \"trueText\": \"\",\n \"type\": \"\",\n \"typeface\": \"\",\n \"uppercase\": false,\n \"vAlignment\": \"\",\n \"width\": \"\",\n \"x\": \"\",\n \"y\": \"\"\n }\n ]\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/templates/:template_id/add_fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'fields' => [
[
'alignment' => '',
'autoCalculateMaxLength' => null,
'backgroundColor' => '',
'backgroundColorFieldName' => '',
'backgroundColorFieldRequired' => null,
'barcodeSymbology' => '',
'bold' => null,
'characterSpacing' => '',
'checkCharacter' => '',
'checkColor' => '',
'checkColorFieldName' => '',
'checkColorFieldRequired' => null,
'color' => '',
'colorFieldName' => '',
'colorFieldRequired' => null,
'comb' => null,
'combNumberOfCells' => '',
'combValueOffset' => '',
'combinedFieldFormat' => '',
'combinedFieldNames' => '',
'combinedFieldSeparator' => '',
'combinedFieldType' => '',
'condition' => '',
'currency' => null,
'dateTimeFormat' => '',
'decimalPlaces' => '',
'default' => '',
'description' => '',
'displayType' => '',
'exclusiveMaximum' => null,
'exclusiveMinimum' => null,
'falseText' => '',
'fontSize' => '',
'height' => '',
'hidden' => null,
'id' => '',
'imageGravity' => '',
'imageScaleType' => '',
'includeTime' => null,
'integer' => null,
'invertBooleanCondition' => null,
'maxLength' => '',
'maximum' => '',
'metadata' => '',
'minLength' => '',
'minimum' => '',
'multiline' => null,
'multilineLines' => '',
'name' => '',
'numberConditionRangeExclusiveMax' => null,
'numberConditionRangeExclusiveMin' => null,
'numberConditionRangeMax' => '',
'numberConditionRangeMin' => '',
'numberConditionType' => '',
'opacity' => '',
'optionList' => '',
'overflow' => '',
'page' => '',
'placeholder' => '',
'qrcodeColor' => '',
'qrcodeColorFieldName' => '',
'qrcodeColorFieldRequired' => null,
'required' => null,
'rotation' => '',
'shapeBorderColor' => '',
'shapeBorderColorFieldName' => '',
'shapeBorderColorFieldRequired' => null,
'shapeBorderWidth' => '',
'shapeFillColor' => '',
'shapeFillColorFieldName' => '',
'shapeFillColorFieldRequired' => null,
'shapeType' => '',
'signatureAllowDraw' => null,
'signatureAllowType' => null,
'static' => null,
'strikethrough' => null,
'stringConditionType' => '',
'title' => '',
'trueText' => '',
'type' => '',
'typeface' => '',
'uppercase' => null,
'vAlignment' => '',
'width' => '',
'x' => '',
'y' => ''
]
]
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('PUT', '{{baseUrl}}/templates/:template_id/add_fields', [
'body' => '{
"fields": [
{
"alignment": "",
"autoCalculateMaxLength": false,
"backgroundColor": "",
"backgroundColorFieldName": "",
"backgroundColorFieldRequired": false,
"barcodeSymbology": "",
"bold": false,
"characterSpacing": "",
"checkCharacter": "",
"checkColor": "",
"checkColorFieldName": "",
"checkColorFieldRequired": false,
"color": "",
"colorFieldName": "",
"colorFieldRequired": false,
"comb": false,
"combNumberOfCells": "",
"combValueOffset": "",
"combinedFieldFormat": "",
"combinedFieldNames": "",
"combinedFieldSeparator": "",
"combinedFieldType": "",
"condition": "",
"currency": false,
"dateTimeFormat": "",
"decimalPlaces": "",
"default": "",
"description": "",
"displayType": "",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"falseText": "",
"fontSize": "",
"height": "",
"hidden": false,
"id": "",
"imageGravity": "",
"imageScaleType": "",
"includeTime": false,
"integer": false,
"invertBooleanCondition": false,
"maxLength": "",
"maximum": "",
"metadata": "",
"minLength": "",
"minimum": "",
"multiline": false,
"multilineLines": "",
"name": "",
"numberConditionRangeExclusiveMax": false,
"numberConditionRangeExclusiveMin": false,
"numberConditionRangeMax": "",
"numberConditionRangeMin": "",
"numberConditionType": "",
"opacity": "",
"optionList": "",
"overflow": "",
"page": "",
"placeholder": "",
"qrcodeColor": "",
"qrcodeColorFieldName": "",
"qrcodeColorFieldRequired": false,
"required": false,
"rotation": "",
"shapeBorderColor": "",
"shapeBorderColorFieldName": "",
"shapeBorderColorFieldRequired": false,
"shapeBorderWidth": "",
"shapeFillColor": "",
"shapeFillColorFieldName": "",
"shapeFillColorFieldRequired": false,
"shapeType": "",
"signatureAllowDraw": false,
"signatureAllowType": false,
"static": false,
"strikethrough": false,
"stringConditionType": "",
"title": "",
"trueText": "",
"type": "",
"typeface": "",
"uppercase": false,
"vAlignment": "",
"width": "",
"x": "",
"y": ""
}
]
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/templates/:template_id/add_fields');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'fields' => [
[
'alignment' => '',
'autoCalculateMaxLength' => null,
'backgroundColor' => '',
'backgroundColorFieldName' => '',
'backgroundColorFieldRequired' => null,
'barcodeSymbology' => '',
'bold' => null,
'characterSpacing' => '',
'checkCharacter' => '',
'checkColor' => '',
'checkColorFieldName' => '',
'checkColorFieldRequired' => null,
'color' => '',
'colorFieldName' => '',
'colorFieldRequired' => null,
'comb' => null,
'combNumberOfCells' => '',
'combValueOffset' => '',
'combinedFieldFormat' => '',
'combinedFieldNames' => '',
'combinedFieldSeparator' => '',
'combinedFieldType' => '',
'condition' => '',
'currency' => null,
'dateTimeFormat' => '',
'decimalPlaces' => '',
'default' => '',
'description' => '',
'displayType' => '',
'exclusiveMaximum' => null,
'exclusiveMinimum' => null,
'falseText' => '',
'fontSize' => '',
'height' => '',
'hidden' => null,
'id' => '',
'imageGravity' => '',
'imageScaleType' => '',
'includeTime' => null,
'integer' => null,
'invertBooleanCondition' => null,
'maxLength' => '',
'maximum' => '',
'metadata' => '',
'minLength' => '',
'minimum' => '',
'multiline' => null,
'multilineLines' => '',
'name' => '',
'numberConditionRangeExclusiveMax' => null,
'numberConditionRangeExclusiveMin' => null,
'numberConditionRangeMax' => '',
'numberConditionRangeMin' => '',
'numberConditionType' => '',
'opacity' => '',
'optionList' => '',
'overflow' => '',
'page' => '',
'placeholder' => '',
'qrcodeColor' => '',
'qrcodeColorFieldName' => '',
'qrcodeColorFieldRequired' => null,
'required' => null,
'rotation' => '',
'shapeBorderColor' => '',
'shapeBorderColorFieldName' => '',
'shapeBorderColorFieldRequired' => null,
'shapeBorderWidth' => '',
'shapeFillColor' => '',
'shapeFillColorFieldName' => '',
'shapeFillColorFieldRequired' => null,
'shapeType' => '',
'signatureAllowDraw' => null,
'signatureAllowType' => null,
'static' => null,
'strikethrough' => null,
'stringConditionType' => '',
'title' => '',
'trueText' => '',
'type' => '',
'typeface' => '',
'uppercase' => null,
'vAlignment' => '',
'width' => '',
'x' => '',
'y' => ''
]
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'fields' => [
[
'alignment' => '',
'autoCalculateMaxLength' => null,
'backgroundColor' => '',
'backgroundColorFieldName' => '',
'backgroundColorFieldRequired' => null,
'barcodeSymbology' => '',
'bold' => null,
'characterSpacing' => '',
'checkCharacter' => '',
'checkColor' => '',
'checkColorFieldName' => '',
'checkColorFieldRequired' => null,
'color' => '',
'colorFieldName' => '',
'colorFieldRequired' => null,
'comb' => null,
'combNumberOfCells' => '',
'combValueOffset' => '',
'combinedFieldFormat' => '',
'combinedFieldNames' => '',
'combinedFieldSeparator' => '',
'combinedFieldType' => '',
'condition' => '',
'currency' => null,
'dateTimeFormat' => '',
'decimalPlaces' => '',
'default' => '',
'description' => '',
'displayType' => '',
'exclusiveMaximum' => null,
'exclusiveMinimum' => null,
'falseText' => '',
'fontSize' => '',
'height' => '',
'hidden' => null,
'id' => '',
'imageGravity' => '',
'imageScaleType' => '',
'includeTime' => null,
'integer' => null,
'invertBooleanCondition' => null,
'maxLength' => '',
'maximum' => '',
'metadata' => '',
'minLength' => '',
'minimum' => '',
'multiline' => null,
'multilineLines' => '',
'name' => '',
'numberConditionRangeExclusiveMax' => null,
'numberConditionRangeExclusiveMin' => null,
'numberConditionRangeMax' => '',
'numberConditionRangeMin' => '',
'numberConditionType' => '',
'opacity' => '',
'optionList' => '',
'overflow' => '',
'page' => '',
'placeholder' => '',
'qrcodeColor' => '',
'qrcodeColorFieldName' => '',
'qrcodeColorFieldRequired' => null,
'required' => null,
'rotation' => '',
'shapeBorderColor' => '',
'shapeBorderColorFieldName' => '',
'shapeBorderColorFieldRequired' => null,
'shapeBorderWidth' => '',
'shapeFillColor' => '',
'shapeFillColorFieldName' => '',
'shapeFillColorFieldRequired' => null,
'shapeType' => '',
'signatureAllowDraw' => null,
'signatureAllowType' => null,
'static' => null,
'strikethrough' => null,
'stringConditionType' => '',
'title' => '',
'trueText' => '',
'type' => '',
'typeface' => '',
'uppercase' => null,
'vAlignment' => '',
'width' => '',
'x' => '',
'y' => ''
]
]
]));
$request->setRequestUrl('{{baseUrl}}/templates/:template_id/add_fields');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/templates/:template_id/add_fields' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"fields": [
{
"alignment": "",
"autoCalculateMaxLength": false,
"backgroundColor": "",
"backgroundColorFieldName": "",
"backgroundColorFieldRequired": false,
"barcodeSymbology": "",
"bold": false,
"characterSpacing": "",
"checkCharacter": "",
"checkColor": "",
"checkColorFieldName": "",
"checkColorFieldRequired": false,
"color": "",
"colorFieldName": "",
"colorFieldRequired": false,
"comb": false,
"combNumberOfCells": "",
"combValueOffset": "",
"combinedFieldFormat": "",
"combinedFieldNames": "",
"combinedFieldSeparator": "",
"combinedFieldType": "",
"condition": "",
"currency": false,
"dateTimeFormat": "",
"decimalPlaces": "",
"default": "",
"description": "",
"displayType": "",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"falseText": "",
"fontSize": "",
"height": "",
"hidden": false,
"id": "",
"imageGravity": "",
"imageScaleType": "",
"includeTime": false,
"integer": false,
"invertBooleanCondition": false,
"maxLength": "",
"maximum": "",
"metadata": "",
"minLength": "",
"minimum": "",
"multiline": false,
"multilineLines": "",
"name": "",
"numberConditionRangeExclusiveMax": false,
"numberConditionRangeExclusiveMin": false,
"numberConditionRangeMax": "",
"numberConditionRangeMin": "",
"numberConditionType": "",
"opacity": "",
"optionList": "",
"overflow": "",
"page": "",
"placeholder": "",
"qrcodeColor": "",
"qrcodeColorFieldName": "",
"qrcodeColorFieldRequired": false,
"required": false,
"rotation": "",
"shapeBorderColor": "",
"shapeBorderColorFieldName": "",
"shapeBorderColorFieldRequired": false,
"shapeBorderWidth": "",
"shapeFillColor": "",
"shapeFillColorFieldName": "",
"shapeFillColorFieldRequired": false,
"shapeType": "",
"signatureAllowDraw": false,
"signatureAllowType": false,
"static": false,
"strikethrough": false,
"stringConditionType": "",
"title": "",
"trueText": "",
"type": "",
"typeface": "",
"uppercase": false,
"vAlignment": "",
"width": "",
"x": "",
"y": ""
}
]
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/templates/:template_id/add_fields' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"fields": [
{
"alignment": "",
"autoCalculateMaxLength": false,
"backgroundColor": "",
"backgroundColorFieldName": "",
"backgroundColorFieldRequired": false,
"barcodeSymbology": "",
"bold": false,
"characterSpacing": "",
"checkCharacter": "",
"checkColor": "",
"checkColorFieldName": "",
"checkColorFieldRequired": false,
"color": "",
"colorFieldName": "",
"colorFieldRequired": false,
"comb": false,
"combNumberOfCells": "",
"combValueOffset": "",
"combinedFieldFormat": "",
"combinedFieldNames": "",
"combinedFieldSeparator": "",
"combinedFieldType": "",
"condition": "",
"currency": false,
"dateTimeFormat": "",
"decimalPlaces": "",
"default": "",
"description": "",
"displayType": "",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"falseText": "",
"fontSize": "",
"height": "",
"hidden": false,
"id": "",
"imageGravity": "",
"imageScaleType": "",
"includeTime": false,
"integer": false,
"invertBooleanCondition": false,
"maxLength": "",
"maximum": "",
"metadata": "",
"minLength": "",
"minimum": "",
"multiline": false,
"multilineLines": "",
"name": "",
"numberConditionRangeExclusiveMax": false,
"numberConditionRangeExclusiveMin": false,
"numberConditionRangeMax": "",
"numberConditionRangeMin": "",
"numberConditionType": "",
"opacity": "",
"optionList": "",
"overflow": "",
"page": "",
"placeholder": "",
"qrcodeColor": "",
"qrcodeColorFieldName": "",
"qrcodeColorFieldRequired": false,
"required": false,
"rotation": "",
"shapeBorderColor": "",
"shapeBorderColorFieldName": "",
"shapeBorderColorFieldRequired": false,
"shapeBorderWidth": "",
"shapeFillColor": "",
"shapeFillColorFieldName": "",
"shapeFillColorFieldRequired": false,
"shapeType": "",
"signatureAllowDraw": false,
"signatureAllowType": false,
"static": false,
"strikethrough": false,
"stringConditionType": "",
"title": "",
"trueText": "",
"type": "",
"typeface": "",
"uppercase": false,
"vAlignment": "",
"width": "",
"x": "",
"y": ""
}
]
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"fields\": [\n {\n \"alignment\": \"\",\n \"autoCalculateMaxLength\": false,\n \"backgroundColor\": \"\",\n \"backgroundColorFieldName\": \"\",\n \"backgroundColorFieldRequired\": false,\n \"barcodeSymbology\": \"\",\n \"bold\": false,\n \"characterSpacing\": \"\",\n \"checkCharacter\": \"\",\n \"checkColor\": \"\",\n \"checkColorFieldName\": \"\",\n \"checkColorFieldRequired\": false,\n \"color\": \"\",\n \"colorFieldName\": \"\",\n \"colorFieldRequired\": false,\n \"comb\": false,\n \"combNumberOfCells\": \"\",\n \"combValueOffset\": \"\",\n \"combinedFieldFormat\": \"\",\n \"combinedFieldNames\": \"\",\n \"combinedFieldSeparator\": \"\",\n \"combinedFieldType\": \"\",\n \"condition\": \"\",\n \"currency\": false,\n \"dateTimeFormat\": \"\",\n \"decimalPlaces\": \"\",\n \"default\": \"\",\n \"description\": \"\",\n \"displayType\": \"\",\n \"exclusiveMaximum\": false,\n \"exclusiveMinimum\": false,\n \"falseText\": \"\",\n \"fontSize\": \"\",\n \"height\": \"\",\n \"hidden\": false,\n \"id\": \"\",\n \"imageGravity\": \"\",\n \"imageScaleType\": \"\",\n \"includeTime\": false,\n \"integer\": false,\n \"invertBooleanCondition\": false,\n \"maxLength\": \"\",\n \"maximum\": \"\",\n \"metadata\": \"\",\n \"minLength\": \"\",\n \"minimum\": \"\",\n \"multiline\": false,\n \"multilineLines\": \"\",\n \"name\": \"\",\n \"numberConditionRangeExclusiveMax\": false,\n \"numberConditionRangeExclusiveMin\": false,\n \"numberConditionRangeMax\": \"\",\n \"numberConditionRangeMin\": \"\",\n \"numberConditionType\": \"\",\n \"opacity\": \"\",\n \"optionList\": \"\",\n \"overflow\": \"\",\n \"page\": \"\",\n \"placeholder\": \"\",\n \"qrcodeColor\": \"\",\n \"qrcodeColorFieldName\": \"\",\n \"qrcodeColorFieldRequired\": false,\n \"required\": false,\n \"rotation\": \"\",\n \"shapeBorderColor\": \"\",\n \"shapeBorderColorFieldName\": \"\",\n \"shapeBorderColorFieldRequired\": false,\n \"shapeBorderWidth\": \"\",\n \"shapeFillColor\": \"\",\n \"shapeFillColorFieldName\": \"\",\n \"shapeFillColorFieldRequired\": false,\n \"shapeType\": \"\",\n \"signatureAllowDraw\": false,\n \"signatureAllowType\": false,\n \"static\": false,\n \"strikethrough\": false,\n \"stringConditionType\": \"\",\n \"title\": \"\",\n \"trueText\": \"\",\n \"type\": \"\",\n \"typeface\": \"\",\n \"uppercase\": false,\n \"vAlignment\": \"\",\n \"width\": \"\",\n \"x\": \"\",\n \"y\": \"\"\n }\n ]\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/templates/:template_id/add_fields", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/templates/:template_id/add_fields"
payload = { "fields": [
{
"alignment": "",
"autoCalculateMaxLength": False,
"backgroundColor": "",
"backgroundColorFieldName": "",
"backgroundColorFieldRequired": False,
"barcodeSymbology": "",
"bold": False,
"characterSpacing": "",
"checkCharacter": "",
"checkColor": "",
"checkColorFieldName": "",
"checkColorFieldRequired": False,
"color": "",
"colorFieldName": "",
"colorFieldRequired": False,
"comb": False,
"combNumberOfCells": "",
"combValueOffset": "",
"combinedFieldFormat": "",
"combinedFieldNames": "",
"combinedFieldSeparator": "",
"combinedFieldType": "",
"condition": "",
"currency": False,
"dateTimeFormat": "",
"decimalPlaces": "",
"default": "",
"description": "",
"displayType": "",
"exclusiveMaximum": False,
"exclusiveMinimum": False,
"falseText": "",
"fontSize": "",
"height": "",
"hidden": False,
"id": "",
"imageGravity": "",
"imageScaleType": "",
"includeTime": False,
"integer": False,
"invertBooleanCondition": False,
"maxLength": "",
"maximum": "",
"metadata": "",
"minLength": "",
"minimum": "",
"multiline": False,
"multilineLines": "",
"name": "",
"numberConditionRangeExclusiveMax": False,
"numberConditionRangeExclusiveMin": False,
"numberConditionRangeMax": "",
"numberConditionRangeMin": "",
"numberConditionType": "",
"opacity": "",
"optionList": "",
"overflow": "",
"page": "",
"placeholder": "",
"qrcodeColor": "",
"qrcodeColorFieldName": "",
"qrcodeColorFieldRequired": False,
"required": False,
"rotation": "",
"shapeBorderColor": "",
"shapeBorderColorFieldName": "",
"shapeBorderColorFieldRequired": False,
"shapeBorderWidth": "",
"shapeFillColor": "",
"shapeFillColorFieldName": "",
"shapeFillColorFieldRequired": False,
"shapeType": "",
"signatureAllowDraw": False,
"signatureAllowType": False,
"static": False,
"strikethrough": False,
"stringConditionType": "",
"title": "",
"trueText": "",
"type": "",
"typeface": "",
"uppercase": False,
"vAlignment": "",
"width": "",
"x": "",
"y": ""
}
] }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/templates/:template_id/add_fields"
payload <- "{\n \"fields\": [\n {\n \"alignment\": \"\",\n \"autoCalculateMaxLength\": false,\n \"backgroundColor\": \"\",\n \"backgroundColorFieldName\": \"\",\n \"backgroundColorFieldRequired\": false,\n \"barcodeSymbology\": \"\",\n \"bold\": false,\n \"characterSpacing\": \"\",\n \"checkCharacter\": \"\",\n \"checkColor\": \"\",\n \"checkColorFieldName\": \"\",\n \"checkColorFieldRequired\": false,\n \"color\": \"\",\n \"colorFieldName\": \"\",\n \"colorFieldRequired\": false,\n \"comb\": false,\n \"combNumberOfCells\": \"\",\n \"combValueOffset\": \"\",\n \"combinedFieldFormat\": \"\",\n \"combinedFieldNames\": \"\",\n \"combinedFieldSeparator\": \"\",\n \"combinedFieldType\": \"\",\n \"condition\": \"\",\n \"currency\": false,\n \"dateTimeFormat\": \"\",\n \"decimalPlaces\": \"\",\n \"default\": \"\",\n \"description\": \"\",\n \"displayType\": \"\",\n \"exclusiveMaximum\": false,\n \"exclusiveMinimum\": false,\n \"falseText\": \"\",\n \"fontSize\": \"\",\n \"height\": \"\",\n \"hidden\": false,\n \"id\": \"\",\n \"imageGravity\": \"\",\n \"imageScaleType\": \"\",\n \"includeTime\": false,\n \"integer\": false,\n \"invertBooleanCondition\": false,\n \"maxLength\": \"\",\n \"maximum\": \"\",\n \"metadata\": \"\",\n \"minLength\": \"\",\n \"minimum\": \"\",\n \"multiline\": false,\n \"multilineLines\": \"\",\n \"name\": \"\",\n \"numberConditionRangeExclusiveMax\": false,\n \"numberConditionRangeExclusiveMin\": false,\n \"numberConditionRangeMax\": \"\",\n \"numberConditionRangeMin\": \"\",\n \"numberConditionType\": \"\",\n \"opacity\": \"\",\n \"optionList\": \"\",\n \"overflow\": \"\",\n \"page\": \"\",\n \"placeholder\": \"\",\n \"qrcodeColor\": \"\",\n \"qrcodeColorFieldName\": \"\",\n \"qrcodeColorFieldRequired\": false,\n \"required\": false,\n \"rotation\": \"\",\n \"shapeBorderColor\": \"\",\n \"shapeBorderColorFieldName\": \"\",\n \"shapeBorderColorFieldRequired\": false,\n \"shapeBorderWidth\": \"\",\n \"shapeFillColor\": \"\",\n \"shapeFillColorFieldName\": \"\",\n \"shapeFillColorFieldRequired\": false,\n \"shapeType\": \"\",\n \"signatureAllowDraw\": false,\n \"signatureAllowType\": false,\n \"static\": false,\n \"strikethrough\": false,\n \"stringConditionType\": \"\",\n \"title\": \"\",\n \"trueText\": \"\",\n \"type\": \"\",\n \"typeface\": \"\",\n \"uppercase\": false,\n \"vAlignment\": \"\",\n \"width\": \"\",\n \"x\": \"\",\n \"y\": \"\"\n }\n ]\n}"
encode <- "json"
response <- VERB("PUT", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/templates/:template_id/add_fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"fields\": [\n {\n \"alignment\": \"\",\n \"autoCalculateMaxLength\": false,\n \"backgroundColor\": \"\",\n \"backgroundColorFieldName\": \"\",\n \"backgroundColorFieldRequired\": false,\n \"barcodeSymbology\": \"\",\n \"bold\": false,\n \"characterSpacing\": \"\",\n \"checkCharacter\": \"\",\n \"checkColor\": \"\",\n \"checkColorFieldName\": \"\",\n \"checkColorFieldRequired\": false,\n \"color\": \"\",\n \"colorFieldName\": \"\",\n \"colorFieldRequired\": false,\n \"comb\": false,\n \"combNumberOfCells\": \"\",\n \"combValueOffset\": \"\",\n \"combinedFieldFormat\": \"\",\n \"combinedFieldNames\": \"\",\n \"combinedFieldSeparator\": \"\",\n \"combinedFieldType\": \"\",\n \"condition\": \"\",\n \"currency\": false,\n \"dateTimeFormat\": \"\",\n \"decimalPlaces\": \"\",\n \"default\": \"\",\n \"description\": \"\",\n \"displayType\": \"\",\n \"exclusiveMaximum\": false,\n \"exclusiveMinimum\": false,\n \"falseText\": \"\",\n \"fontSize\": \"\",\n \"height\": \"\",\n \"hidden\": false,\n \"id\": \"\",\n \"imageGravity\": \"\",\n \"imageScaleType\": \"\",\n \"includeTime\": false,\n \"integer\": false,\n \"invertBooleanCondition\": false,\n \"maxLength\": \"\",\n \"maximum\": \"\",\n \"metadata\": \"\",\n \"minLength\": \"\",\n \"minimum\": \"\",\n \"multiline\": false,\n \"multilineLines\": \"\",\n \"name\": \"\",\n \"numberConditionRangeExclusiveMax\": false,\n \"numberConditionRangeExclusiveMin\": false,\n \"numberConditionRangeMax\": \"\",\n \"numberConditionRangeMin\": \"\",\n \"numberConditionType\": \"\",\n \"opacity\": \"\",\n \"optionList\": \"\",\n \"overflow\": \"\",\n \"page\": \"\",\n \"placeholder\": \"\",\n \"qrcodeColor\": \"\",\n \"qrcodeColorFieldName\": \"\",\n \"qrcodeColorFieldRequired\": false,\n \"required\": false,\n \"rotation\": \"\",\n \"shapeBorderColor\": \"\",\n \"shapeBorderColorFieldName\": \"\",\n \"shapeBorderColorFieldRequired\": false,\n \"shapeBorderWidth\": \"\",\n \"shapeFillColor\": \"\",\n \"shapeFillColorFieldName\": \"\",\n \"shapeFillColorFieldRequired\": false,\n \"shapeType\": \"\",\n \"signatureAllowDraw\": false,\n \"signatureAllowType\": false,\n \"static\": false,\n \"strikethrough\": false,\n \"stringConditionType\": \"\",\n \"title\": \"\",\n \"trueText\": \"\",\n \"type\": \"\",\n \"typeface\": \"\",\n \"uppercase\": false,\n \"vAlignment\": \"\",\n \"width\": \"\",\n \"x\": \"\",\n \"y\": \"\"\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/templates/:template_id/add_fields') do |req|
req.body = "{\n \"fields\": [\n {\n \"alignment\": \"\",\n \"autoCalculateMaxLength\": false,\n \"backgroundColor\": \"\",\n \"backgroundColorFieldName\": \"\",\n \"backgroundColorFieldRequired\": false,\n \"barcodeSymbology\": \"\",\n \"bold\": false,\n \"characterSpacing\": \"\",\n \"checkCharacter\": \"\",\n \"checkColor\": \"\",\n \"checkColorFieldName\": \"\",\n \"checkColorFieldRequired\": false,\n \"color\": \"\",\n \"colorFieldName\": \"\",\n \"colorFieldRequired\": false,\n \"comb\": false,\n \"combNumberOfCells\": \"\",\n \"combValueOffset\": \"\",\n \"combinedFieldFormat\": \"\",\n \"combinedFieldNames\": \"\",\n \"combinedFieldSeparator\": \"\",\n \"combinedFieldType\": \"\",\n \"condition\": \"\",\n \"currency\": false,\n \"dateTimeFormat\": \"\",\n \"decimalPlaces\": \"\",\n \"default\": \"\",\n \"description\": \"\",\n \"displayType\": \"\",\n \"exclusiveMaximum\": false,\n \"exclusiveMinimum\": false,\n \"falseText\": \"\",\n \"fontSize\": \"\",\n \"height\": \"\",\n \"hidden\": false,\n \"id\": \"\",\n \"imageGravity\": \"\",\n \"imageScaleType\": \"\",\n \"includeTime\": false,\n \"integer\": false,\n \"invertBooleanCondition\": false,\n \"maxLength\": \"\",\n \"maximum\": \"\",\n \"metadata\": \"\",\n \"minLength\": \"\",\n \"minimum\": \"\",\n \"multiline\": false,\n \"multilineLines\": \"\",\n \"name\": \"\",\n \"numberConditionRangeExclusiveMax\": false,\n \"numberConditionRangeExclusiveMin\": false,\n \"numberConditionRangeMax\": \"\",\n \"numberConditionRangeMin\": \"\",\n \"numberConditionType\": \"\",\n \"opacity\": \"\",\n \"optionList\": \"\",\n \"overflow\": \"\",\n \"page\": \"\",\n \"placeholder\": \"\",\n \"qrcodeColor\": \"\",\n \"qrcodeColorFieldName\": \"\",\n \"qrcodeColorFieldRequired\": false,\n \"required\": false,\n \"rotation\": \"\",\n \"shapeBorderColor\": \"\",\n \"shapeBorderColorFieldName\": \"\",\n \"shapeBorderColorFieldRequired\": false,\n \"shapeBorderWidth\": \"\",\n \"shapeFillColor\": \"\",\n \"shapeFillColorFieldName\": \"\",\n \"shapeFillColorFieldRequired\": false,\n \"shapeType\": \"\",\n \"signatureAllowDraw\": false,\n \"signatureAllowType\": false,\n \"static\": false,\n \"strikethrough\": false,\n \"stringConditionType\": \"\",\n \"title\": \"\",\n \"trueText\": \"\",\n \"type\": \"\",\n \"typeface\": \"\",\n \"uppercase\": false,\n \"vAlignment\": \"\",\n \"width\": \"\",\n \"x\": \"\",\n \"y\": \"\"\n }\n ]\n}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/templates/:template_id/add_fields";
let payload = json!({"fields": (
json!({
"alignment": "",
"autoCalculateMaxLength": false,
"backgroundColor": "",
"backgroundColorFieldName": "",
"backgroundColorFieldRequired": false,
"barcodeSymbology": "",
"bold": false,
"characterSpacing": "",
"checkCharacter": "",
"checkColor": "",
"checkColorFieldName": "",
"checkColorFieldRequired": false,
"color": "",
"colorFieldName": "",
"colorFieldRequired": false,
"comb": false,
"combNumberOfCells": "",
"combValueOffset": "",
"combinedFieldFormat": "",
"combinedFieldNames": "",
"combinedFieldSeparator": "",
"combinedFieldType": "",
"condition": "",
"currency": false,
"dateTimeFormat": "",
"decimalPlaces": "",
"default": "",
"description": "",
"displayType": "",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"falseText": "",
"fontSize": "",
"height": "",
"hidden": false,
"id": "",
"imageGravity": "",
"imageScaleType": "",
"includeTime": false,
"integer": false,
"invertBooleanCondition": false,
"maxLength": "",
"maximum": "",
"metadata": "",
"minLength": "",
"minimum": "",
"multiline": false,
"multilineLines": "",
"name": "",
"numberConditionRangeExclusiveMax": false,
"numberConditionRangeExclusiveMin": false,
"numberConditionRangeMax": "",
"numberConditionRangeMin": "",
"numberConditionType": "",
"opacity": "",
"optionList": "",
"overflow": "",
"page": "",
"placeholder": "",
"qrcodeColor": "",
"qrcodeColorFieldName": "",
"qrcodeColorFieldRequired": false,
"required": false,
"rotation": "",
"shapeBorderColor": "",
"shapeBorderColorFieldName": "",
"shapeBorderColorFieldRequired": false,
"shapeBorderWidth": "",
"shapeFillColor": "",
"shapeFillColorFieldName": "",
"shapeFillColorFieldRequired": false,
"shapeType": "",
"signatureAllowDraw": false,
"signatureAllowType": false,
"static": false,
"strikethrough": false,
"stringConditionType": "",
"title": "",
"trueText": "",
"type": "",
"typeface": "",
"uppercase": false,
"vAlignment": "",
"width": "",
"x": "",
"y": ""
})
)});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/templates/:template_id/add_fields \
--header 'content-type: application/json' \
--data '{
"fields": [
{
"alignment": "",
"autoCalculateMaxLength": false,
"backgroundColor": "",
"backgroundColorFieldName": "",
"backgroundColorFieldRequired": false,
"barcodeSymbology": "",
"bold": false,
"characterSpacing": "",
"checkCharacter": "",
"checkColor": "",
"checkColorFieldName": "",
"checkColorFieldRequired": false,
"color": "",
"colorFieldName": "",
"colorFieldRequired": false,
"comb": false,
"combNumberOfCells": "",
"combValueOffset": "",
"combinedFieldFormat": "",
"combinedFieldNames": "",
"combinedFieldSeparator": "",
"combinedFieldType": "",
"condition": "",
"currency": false,
"dateTimeFormat": "",
"decimalPlaces": "",
"default": "",
"description": "",
"displayType": "",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"falseText": "",
"fontSize": "",
"height": "",
"hidden": false,
"id": "",
"imageGravity": "",
"imageScaleType": "",
"includeTime": false,
"integer": false,
"invertBooleanCondition": false,
"maxLength": "",
"maximum": "",
"metadata": "",
"minLength": "",
"minimum": "",
"multiline": false,
"multilineLines": "",
"name": "",
"numberConditionRangeExclusiveMax": false,
"numberConditionRangeExclusiveMin": false,
"numberConditionRangeMax": "",
"numberConditionRangeMin": "",
"numberConditionType": "",
"opacity": "",
"optionList": "",
"overflow": "",
"page": "",
"placeholder": "",
"qrcodeColor": "",
"qrcodeColorFieldName": "",
"qrcodeColorFieldRequired": false,
"required": false,
"rotation": "",
"shapeBorderColor": "",
"shapeBorderColorFieldName": "",
"shapeBorderColorFieldRequired": false,
"shapeBorderWidth": "",
"shapeFillColor": "",
"shapeFillColorFieldName": "",
"shapeFillColorFieldRequired": false,
"shapeType": "",
"signatureAllowDraw": false,
"signatureAllowType": false,
"static": false,
"strikethrough": false,
"stringConditionType": "",
"title": "",
"trueText": "",
"type": "",
"typeface": "",
"uppercase": false,
"vAlignment": "",
"width": "",
"x": "",
"y": ""
}
]
}'echo '{
"fields": [
{
"alignment": "",
"autoCalculateMaxLength": false,
"backgroundColor": "",
"backgroundColorFieldName": "",
"backgroundColorFieldRequired": false,
"barcodeSymbology": "",
"bold": false,
"characterSpacing": "",
"checkCharacter": "",
"checkColor": "",
"checkColorFieldName": "",
"checkColorFieldRequired": false,
"color": "",
"colorFieldName": "",
"colorFieldRequired": false,
"comb": false,
"combNumberOfCells": "",
"combValueOffset": "",
"combinedFieldFormat": "",
"combinedFieldNames": "",
"combinedFieldSeparator": "",
"combinedFieldType": "",
"condition": "",
"currency": false,
"dateTimeFormat": "",
"decimalPlaces": "",
"default": "",
"description": "",
"displayType": "",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"falseText": "",
"fontSize": "",
"height": "",
"hidden": false,
"id": "",
"imageGravity": "",
"imageScaleType": "",
"includeTime": false,
"integer": false,
"invertBooleanCondition": false,
"maxLength": "",
"maximum": "",
"metadata": "",
"minLength": "",
"minimum": "",
"multiline": false,
"multilineLines": "",
"name": "",
"numberConditionRangeExclusiveMax": false,
"numberConditionRangeExclusiveMin": false,
"numberConditionRangeMax": "",
"numberConditionRangeMin": "",
"numberConditionType": "",
"opacity": "",
"optionList": "",
"overflow": "",
"page": "",
"placeholder": "",
"qrcodeColor": "",
"qrcodeColorFieldName": "",
"qrcodeColorFieldRequired": false,
"required": false,
"rotation": "",
"shapeBorderColor": "",
"shapeBorderColorFieldName": "",
"shapeBorderColorFieldRequired": false,
"shapeBorderWidth": "",
"shapeFillColor": "",
"shapeFillColorFieldName": "",
"shapeFillColorFieldRequired": false,
"shapeType": "",
"signatureAllowDraw": false,
"signatureAllowType": false,
"static": false,
"strikethrough": false,
"stringConditionType": "",
"title": "",
"trueText": "",
"type": "",
"typeface": "",
"uppercase": false,
"vAlignment": "",
"width": "",
"x": "",
"y": ""
}
]
}' | \
http PUT {{baseUrl}}/templates/:template_id/add_fields \
content-type:application/jsonwget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "fields": [\n {\n "alignment": "",\n "autoCalculateMaxLength": false,\n "backgroundColor": "",\n "backgroundColorFieldName": "",\n "backgroundColorFieldRequired": false,\n "barcodeSymbology": "",\n "bold": false,\n "characterSpacing": "",\n "checkCharacter": "",\n "checkColor": "",\n "checkColorFieldName": "",\n "checkColorFieldRequired": false,\n "color": "",\n "colorFieldName": "",\n "colorFieldRequired": false,\n "comb": false,\n "combNumberOfCells": "",\n "combValueOffset": "",\n "combinedFieldFormat": "",\n "combinedFieldNames": "",\n "combinedFieldSeparator": "",\n "combinedFieldType": "",\n "condition": "",\n "currency": false,\n "dateTimeFormat": "",\n "decimalPlaces": "",\n "default": "",\n "description": "",\n "displayType": "",\n "exclusiveMaximum": false,\n "exclusiveMinimum": false,\n "falseText": "",\n "fontSize": "",\n "height": "",\n "hidden": false,\n "id": "",\n "imageGravity": "",\n "imageScaleType": "",\n "includeTime": false,\n "integer": false,\n "invertBooleanCondition": false,\n "maxLength": "",\n "maximum": "",\n "metadata": "",\n "minLength": "",\n "minimum": "",\n "multiline": false,\n "multilineLines": "",\n "name": "",\n "numberConditionRangeExclusiveMax": false,\n "numberConditionRangeExclusiveMin": false,\n "numberConditionRangeMax": "",\n "numberConditionRangeMin": "",\n "numberConditionType": "",\n "opacity": "",\n "optionList": "",\n "overflow": "",\n "page": "",\n "placeholder": "",\n "qrcodeColor": "",\n "qrcodeColorFieldName": "",\n "qrcodeColorFieldRequired": false,\n "required": false,\n "rotation": "",\n "shapeBorderColor": "",\n "shapeBorderColorFieldName": "",\n "shapeBorderColorFieldRequired": false,\n "shapeBorderWidth": "",\n "shapeFillColor": "",\n "shapeFillColorFieldName": "",\n "shapeFillColorFieldRequired": false,\n "shapeType": "",\n "signatureAllowDraw": false,\n "signatureAllowType": false,\n "static": false,\n "strikethrough": false,\n "stringConditionType": "",\n "title": "",\n "trueText": "",\n "type": "",\n "typeface": "",\n "uppercase": false,\n "vAlignment": "",\n "width": "",\n "x": "",\n "y": ""\n }\n ]\n}' \
--output-document \
- {{baseUrl}}/templates/:template_id/add_fieldsimport Foundation
let headers = ["content-type": "application/json"]
let parameters = ["fields": [
[
"alignment": "",
"autoCalculateMaxLength": false,
"backgroundColor": "",
"backgroundColorFieldName": "",
"backgroundColorFieldRequired": false,
"barcodeSymbology": "",
"bold": false,
"characterSpacing": "",
"checkCharacter": "",
"checkColor": "",
"checkColorFieldName": "",
"checkColorFieldRequired": false,
"color": "",
"colorFieldName": "",
"colorFieldRequired": false,
"comb": false,
"combNumberOfCells": "",
"combValueOffset": "",
"combinedFieldFormat": "",
"combinedFieldNames": "",
"combinedFieldSeparator": "",
"combinedFieldType": "",
"condition": "",
"currency": false,
"dateTimeFormat": "",
"decimalPlaces": "",
"default": "",
"description": "",
"displayType": "",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"falseText": "",
"fontSize": "",
"height": "",
"hidden": false,
"id": "",
"imageGravity": "",
"imageScaleType": "",
"includeTime": false,
"integer": false,
"invertBooleanCondition": false,
"maxLength": "",
"maximum": "",
"metadata": "",
"minLength": "",
"minimum": "",
"multiline": false,
"multilineLines": "",
"name": "",
"numberConditionRangeExclusiveMax": false,
"numberConditionRangeExclusiveMin": false,
"numberConditionRangeMax": "",
"numberConditionRangeMin": "",
"numberConditionType": "",
"opacity": "",
"optionList": "",
"overflow": "",
"page": "",
"placeholder": "",
"qrcodeColor": "",
"qrcodeColorFieldName": "",
"qrcodeColorFieldRequired": false,
"required": false,
"rotation": "",
"shapeBorderColor": "",
"shapeBorderColorFieldName": "",
"shapeBorderColorFieldRequired": false,
"shapeBorderWidth": "",
"shapeFillColor": "",
"shapeFillColorFieldName": "",
"shapeFillColorFieldRequired": false,
"shapeType": "",
"signatureAllowDraw": false,
"signatureAllowType": false,
"static": false,
"strikethrough": false,
"stringConditionType": "",
"title": "",
"trueText": "",
"type": "",
"typeface": "",
"uppercase": false,
"vAlignment": "",
"width": "",
"x": "",
"y": ""
]
]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/templates/:template_id/add_fields")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"new_field_ids": [
4,
5,
6,
7,
99,
8
],
"status": "success"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"errors": [
"The property '#/fields/0' did not contain a required property of 'page'",
"The property '#/fields/1/page' did not have a minimum value of 1, inclusively",
"The property '#/fields/5' contains additional properties [\"unknown_property\"] outside of the schema when none are allowed",
"The property '#/fields/6/displayType' value \"unknown display type\" did not match one of the following values: text, check, qrcode, barcode, image, shape",
"The property '#/fields/6/type' value \"unknown type\" did not match one of the following values: string, number, boolean, date, address, country, email, url, image, signature, barcode, combined",
"The property '#/fields/6' did not contain a required property of 'page'",
"The property '#/fields/7/width' of type string did not match the following type: number",
"The property '#/fields/8/height' did not have a minimum value of 0, inclusively",
"The property '#/fields/8/width' did not have a minimum value of 0, inclusively",
"The property '#/fields/8/x' did not have a minimum value of 0, inclusively",
"The property '#/fields/8/y' did not have a minimum value of 0, inclusively",
"The property '#/fields/2/id' value \"1\" is already taken by another field",
"The property '#/fields/2/page' value \"5\" did not have a maximum value of 3, inclusively (Template has 3 pages)",
"The property '#/fields/3/page' value \"4\" did not have a maximum value of 3, inclusively (Template has 3 pages)"
],
"status": "error"
}
GET
Check the status of a PDF
{{baseUrl}}/submissions/:submission_id
QUERY PARAMS
submission_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/submissions/:submission_id");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/submissions/:submission_id")require "http/client"
url = "{{baseUrl}}/submissions/:submission_id"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/submissions/:submission_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/submissions/:submission_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/submissions/:submission_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/submissions/:submission_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/submissions/:submission_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/submissions/:submission_id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/submissions/:submission_id")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/submissions/:submission_id")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/submissions/:submission_id');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/submissions/:submission_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/submissions/:submission_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/submissions/:submission_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/submissions/:submission_id")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/submissions/:submission_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/submissions/:submission_id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/submissions/:submission_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/submissions/:submission_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/submissions/:submission_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/submissions/:submission_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/submissions/:submission_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/submissions/:submission_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/submissions/:submission_id');
echo $response->getBody();setUrl('{{baseUrl}}/submissions/:submission_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/submissions/:submission_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/submissions/:submission_id' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/submissions/:submission_id' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/submissions/:submission_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/submissions/:submission_id"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/submissions/:submission_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/submissions/:submission_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/submissions/:submission_id') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/submissions/:submission_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/submissions/:submission_idhttp GET {{baseUrl}}/submissions/:submission_idwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/submissions/:submission_idimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/submissions/:submission_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"actions": [
{
"action_category": "file_upload",
"action_type": "aws_s3_upload",
"id": "sba_000000000000000001",
"integration_id": "aci_000000000000000001",
"result_data": {
"s3_bucket": "docspring-custom-s3-test",
"s3_key": "templates/tpl_eGc5CmFbPnCCmerqsx/sub_gzYpKDYFqEHxzca4kK.pdf",
"s3_region": "us-east-1",
"s3_url": "https://docspring-custom-s3-test.s3.amazonaws.com/templates/tpl_eGc5CmFbPnCCmerqsx/sub_gzYpKDYFqEHxzca4kK.pdf"
},
"state": "processed"
}
],
"batch_id": null,
"data": {
"first_name": "John C. D. Rom Laserdisk F. Scott Fitzgerald",
"last_name": "Smith",
"phone_number": "+11234567890"
},
"data_requests": [],
"download_url": "https://example.com/submissions/submission.pdf",
"editable": false,
"expired": false,
"expires_at": "2018-10-27T13:00:00Z",
"id": "sub_000000000000000001",
"json_schema_errors": [],
"metadata": {
"qux": "abc",
"user_id": 42
},
"password": null,
"pdf_hash": "bbc369dd471442006963e3244a1b43610e066165c09770978221f91bd7ace8f5",
"permanent_download_url": "http://app.docspring.local/submissions/sub_000000000000000001/download",
"processed_at": "2020-05-14T02:00:00Z",
"referrer": null,
"source": "api",
"state": "processed",
"template_id": "tpl_000000000000000001",
"test": true,
"truncated_text": {
"first_name": [
"F. Scott Fitzgerald"
]
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Unauthorized",
"status": "error"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Submission not found.",
"status": "error"
}
GET
Check the status of a combined submission (merged PDFs)
{{baseUrl}}/combined_submissions/:combined_submission_id
QUERY PARAMS
combined_submission_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/combined_submissions/:combined_submission_id");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/combined_submissions/:combined_submission_id")require "http/client"
url = "{{baseUrl}}/combined_submissions/:combined_submission_id"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/combined_submissions/:combined_submission_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/combined_submissions/:combined_submission_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/combined_submissions/:combined_submission_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/combined_submissions/:combined_submission_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/combined_submissions/:combined_submission_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/combined_submissions/:combined_submission_id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/combined_submissions/:combined_submission_id")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/combined_submissions/:combined_submission_id")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/combined_submissions/:combined_submission_id');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/combined_submissions/:combined_submission_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/combined_submissions/:combined_submission_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/combined_submissions/:combined_submission_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/combined_submissions/:combined_submission_id")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/combined_submissions/:combined_submission_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/combined_submissions/:combined_submission_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/combined_submissions/:combined_submission_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/combined_submissions/:combined_submission_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/combined_submissions/:combined_submission_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/combined_submissions/:combined_submission_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/combined_submissions/:combined_submission_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/combined_submissions/:combined_submission_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/combined_submissions/:combined_submission_id');
echo $response->getBody();setUrl('{{baseUrl}}/combined_submissions/:combined_submission_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/combined_submissions/:combined_submission_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/combined_submissions/:combined_submission_id' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/combined_submissions/:combined_submission_id' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/combined_submissions/:combined_submission_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/combined_submissions/:combined_submission_id"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/combined_submissions/:combined_submission_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/combined_submissions/:combined_submission_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/combined_submissions/:combined_submission_id') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/combined_submissions/:combined_submission_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/combined_submissions/:combined_submission_idhttp GET {{baseUrl}}/combined_submissions/:combined_submission_idwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/combined_submissions/:combined_submission_idimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/combined_submissions/:combined_submission_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"actions": [
{
"action_category": "file_upload",
"action_type": "aws_s3_upload",
"id": "csa_000000000000000001",
"integration_id": "aci_000000000000000001",
"result_data": {
"s3_bucket": "docspring-custom-s3-test",
"s3_key": "acc_1234/2018/combined_submissions/20181005090010-com_1234.pdf",
"s3_region": "us-east-1",
"s3_url": "https://docspring-custom-s3-test.s3.amazonaws.com/acc_1234/2018/combined_submissions/20181005090010-com_1234.pdf"
},
"state": "processed"
}
],
"download_url": "https://example.com/combined_submissions/combined_submission.pdf",
"error_message": null,
"expired": false,
"expires_at": "2018-10-20T13:05:00Z",
"expires_in": 300,
"id": "com_000000000000000001",
"metadata": {
"qux": "abc",
"user_id": 42
},
"password": "p@ssword",
"pdf_hash": "12342342471442006963e3244a1b43610e066165c09770978221f91bd7ace8f5",
"processed_at": "2020-05-14T02:00:00Z",
"source_pdfs": [],
"state": "processed",
"submission_ids": [
"sub_000000000000000001",
"sub_000000000000000002"
]
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Unauthorized"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Combined submission not found.",
"status": "error"
}
GET
Check the status of a submission batch job
{{baseUrl}}/submissions/batches/:submission_batch_id
QUERY PARAMS
submission_batch_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/submissions/batches/:submission_batch_id");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/submissions/batches/:submission_batch_id")require "http/client"
url = "{{baseUrl}}/submissions/batches/:submission_batch_id"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/submissions/batches/:submission_batch_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/submissions/batches/:submission_batch_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/submissions/batches/:submission_batch_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/submissions/batches/:submission_batch_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/submissions/batches/:submission_batch_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/submissions/batches/:submission_batch_id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/submissions/batches/:submission_batch_id")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/submissions/batches/:submission_batch_id")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/submissions/batches/:submission_batch_id');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/submissions/batches/:submission_batch_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/submissions/batches/:submission_batch_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/submissions/batches/:submission_batch_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/submissions/batches/:submission_batch_id")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/submissions/batches/:submission_batch_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/submissions/batches/:submission_batch_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/submissions/batches/:submission_batch_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/submissions/batches/:submission_batch_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/submissions/batches/:submission_batch_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/submissions/batches/:submission_batch_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/submissions/batches/:submission_batch_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/submissions/batches/:submission_batch_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/submissions/batches/:submission_batch_id');
echo $response->getBody();setUrl('{{baseUrl}}/submissions/batches/:submission_batch_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/submissions/batches/:submission_batch_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/submissions/batches/:submission_batch_id' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/submissions/batches/:submission_batch_id' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/submissions/batches/:submission_batch_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/submissions/batches/:submission_batch_id"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/submissions/batches/:submission_batch_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/submissions/batches/:submission_batch_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/submissions/batches/:submission_batch_id') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/submissions/batches/:submission_batch_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/submissions/batches/:submission_batch_idhttp GET {{baseUrl}}/submissions/batches/:submission_batch_idwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/submissions/batches/:submission_batch_idimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/submissions/batches/:submission_batch_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"completion_percentage": 100,
"error_count": 2,
"id": "sbb_000000000000000001",
"metadata": {
"qux": "abc"
},
"pending_count": 0,
"processed_at": null,
"state": "error",
"submissions": [
{
"actions": [],
"batch_id": "sbb_000000000000000001",
"data_requests": [],
"download_url": "https://example.com/submissions/submission.pdf",
"editable": false,
"expired": false,
"expires_at": null,
"id": "sub_000000000000000001",
"json_schema_errors": [],
"metadata": {},
"password": null,
"pdf_hash": "bbc369dd471442006963e3244a1b43610e066165c09770978221f91bd7ace8f5",
"permanent_download_url": "http://app.docspring.local/submissions/sub_000000000000000001/download",
"processed_at": null,
"state": "processed",
"template_id": "tpl_000000000000000001",
"test": false,
"truncated_text": {}
},
{
"actions": [],
"batch_id": "sbb_000000000000000001",
"data_requests": [],
"download_url": "https://example.com/submissions/submission.pdf",
"editable": false,
"expired": false,
"expires_at": null,
"id": "sub_000000000000000002",
"json_schema_errors": [],
"metadata": {},
"password": null,
"pdf_hash": "bbc369dd471442006963e3244a1b43610e066165c09770978221f91bd7ace8f5",
"permanent_download_url": "http://app.docspring.local/submissions/sub_000000000000000002/download",
"processed_at": null,
"state": "processed",
"template_id": "tpl_000000000000000001",
"test": false,
"truncated_text": {}
}
],
"total_count": 10
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Invalid API token secret"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Submission batch not found.",
"status": "error"
}
GET
Check the status of an uploaded template
{{baseUrl}}/templates/:template_id
QUERY PARAMS
template_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/templates/:template_id");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/templates/:template_id")require "http/client"
url = "{{baseUrl}}/templates/:template_id"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/templates/:template_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/templates/:template_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/templates/:template_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/templates/:template_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/templates/:template_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/templates/:template_id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/templates/:template_id")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/templates/:template_id")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/templates/:template_id');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/templates/:template_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/templates/:template_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/templates/:template_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/templates/:template_id")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/templates/:template_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/templates/:template_id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/templates/:template_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/templates/:template_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/templates/:template_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/templates/:template_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/templates/:template_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/templates/:template_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/templates/:template_id');
echo $response->getBody();setUrl('{{baseUrl}}/templates/:template_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/templates/:template_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/templates/:template_id' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/templates/:template_id' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/templates/:template_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/templates/:template_id"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/templates/:template_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/templates/:template_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/templates/:template_id') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/templates/:template_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/templates/:template_idhttp GET {{baseUrl}}/templates/:template_idwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/templates/:template_idimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/templates/:template_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"allow_additional_properties": false,
"description": null,
"document_filename": "blank_pdf.pdf",
"document_processed": true,
"document_state": "processed",
"document_url": "/uploads/test/store/acc_000000000000000001/templates/tpl_000000000000000001/document/original-0000000000.pdf",
"editable_submissions": false,
"expiration_interval": "days",
"expire_after": 7,
"expire_submissions": true,
"id": "tpl_000000000000000001",
"locked": false,
"name": "Template 1",
"page_count": 1,
"page_dimensions": [
[
612,
792
]
],
"parent_folder_id": null,
"path": "/",
"permanent_document_url": "http://app.docspring.local/templates/tpl_000000000000000001/original_pdf?token=123456789abcdef",
"public_submissions": false,
"public_web_form": false,
"redirect_url": null,
"slack_webhook_url": null,
"template_type": "pdf",
"webhook_url": null
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Unauthorized"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Template not found.",
"status": "error"
}
POST
Copy a Template
{{baseUrl}}/templates/:template_id/copy
QUERY PARAMS
template_id
BODY json
{
"name": "",
"parent_folder_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/templates/:template_id/copy");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/templates/:template_id/copy" {:content-type :json
:form-params {:name ""
:parent_folder_id ""}})require "http/client"
url = "{{baseUrl}}/templates/:template_id/copy"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/templates/:template_id/copy"),
Content = new StringContent("{\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/templates/:template_id/copy");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/templates/:template_id/copy"
payload := strings.NewReader("{\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/templates/:template_id/copy HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 42
{
"name": "",
"parent_folder_id": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/templates/:template_id/copy")
.setHeader("content-type", "application/json")
.setBody("{\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/templates/:template_id/copy"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/templates/:template_id/copy")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/templates/:template_id/copy")
.header("content-type", "application/json")
.body("{\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n}")
.asString(); const data = JSON.stringify({
name: '',
parent_folder_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/templates/:template_id/copy');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/templates/:template_id/copy',
headers: {'content-type': 'application/json'},
data: {name: '', parent_folder_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/templates/:template_id/copy';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"name":"","parent_folder_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/templates/:template_id/copy',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "name": "",\n "parent_folder_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/templates/:template_id/copy")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/templates/:template_id/copy',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({name: '', parent_folder_id: ''}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/templates/:template_id/copy',
headers: {'content-type': 'application/json'},
body: {name: '', parent_folder_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/templates/:template_id/copy');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
name: '',
parent_folder_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/templates/:template_id/copy',
headers: {'content-type': 'application/json'},
data: {name: '', parent_folder_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/templates/:template_id/copy';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"name":"","parent_folder_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"name": @"",
@"parent_folder_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/templates/:template_id/copy"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/templates/:template_id/copy" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/templates/:template_id/copy",
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' => '',
'parent_folder_id' => ''
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/templates/:template_id/copy', [
'body' => '{
"name": "",
"parent_folder_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/templates/:template_id/copy');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'name' => '',
'parent_folder_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'name' => '',
'parent_folder_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/templates/:template_id/copy');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/templates/:template_id/copy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"name": "",
"parent_folder_id": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/templates/:template_id/copy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"name": "",
"parent_folder_id": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/templates/:template_id/copy", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/templates/:template_id/copy"
payload = {
"name": "",
"parent_folder_id": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/templates/:template_id/copy"
payload <- "{\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/templates/:template_id/copy")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/templates/:template_id/copy') do |req|
req.body = "{\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/templates/:template_id/copy";
let payload = json!({
"name": "",
"parent_folder_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/templates/:template_id/copy \
--header 'content-type: application/json' \
--data '{
"name": "",
"parent_folder_id": ""
}'echo '{
"name": "",
"parent_folder_id": ""
}' | \
http POST {{baseUrl}}/templates/:template_id/copy \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "name": "",\n "parent_folder_id": ""\n}' \
--output-document \
- {{baseUrl}}/templates/:template_id/copyimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"name": "",
"parent_folder_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/templates/:template_id/copy")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"allow_additional_properties": false,
"description": null,
"document_filename": "blank_pdf.pdf",
"document_processed": true,
"document_state": "processed",
"document_url": "/uploads/test/store/acc_000000000000000001/templates/tpl_00000000000000new1/document/original-0000000000.pdf",
"editable_submissions": false,
"expiration_interval": "days",
"expire_after": 7,
"expire_submissions": true,
"id": "tpl_00000000000000new1",
"locked": false,
"name": "Copied Template Name",
"page_count": 1,
"page_dimensions": [
[
612,
792
]
],
"parent_folder_id": "fld_000000000000000001",
"path": "/Folder",
"permanent_document_url": "http://app.docspring.local/templates/tpl_00000000000000new1/original_pdf?token=123456789abcdef",
"public_submissions": false,
"public_web_form": false,
"redirect_url": null,
"slack_webhook_url": null,
"template_type": "pdf",
"webhook_url": null
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Could not find parent folder MISSING_ID",
"status": "error"
}
POST
Create a folder
{{baseUrl}}/folders/
BODY json
{
"folder": {
"name": "",
"parent_folder_id": ""
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"folder\": {\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/folders/" {:content-type :json
:form-params {:folder {:name ""
:parent_folder_id ""}}})require "http/client"
url = "{{baseUrl}}/folders/"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"folder\": {\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n }\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/folders/"),
Content = new StringContent("{\n \"folder\": {\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n }\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/folders/");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"folder\": {\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/"
payload := strings.NewReader("{\n \"folder\": {\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/folders/ HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 64
{
"folder": {
"name": "",
"parent_folder_id": ""
}
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/folders/")
.setHeader("content-type", "application/json")
.setBody("{\n \"folder\": {\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"folder\": {\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n }\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"folder\": {\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/folders/")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/folders/")
.header("content-type", "application/json")
.body("{\n \"folder\": {\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n }\n}")
.asString(); const data = JSON.stringify({
folder: {
name: '',
parent_folder_id: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/folders/');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/folders/',
headers: {'content-type': 'application/json'},
data: {folder: {name: '', parent_folder_id: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/folders/';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"folder":{"name":"","parent_folder_id":""}}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/folders/',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "folder": {\n "name": "",\n "parent_folder_id": ""\n }\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"folder\": {\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/folders/")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/folders/',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({folder: {name: '', parent_folder_id: ''}}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/folders/',
headers: {'content-type': 'application/json'},
body: {folder: {name: '', parent_folder_id: ''}},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/folders/');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
folder: {
name: '',
parent_folder_id: ''
}
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/folders/',
headers: {'content-type': 'application/json'},
data: {folder: {name: '', parent_folder_id: ''}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"folder":{"name":"","parent_folder_id":""}}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"folder": @{ @"name": @"", @"parent_folder_id": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/folders/" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"folder\": {\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n }\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/folders/",
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([
'folder' => [
'name' => '',
'parent_folder_id' => ''
]
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/folders/', [
'body' => '{
"folder": {
"name": "",
"parent_folder_id": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/folders/');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'folder' => [
'name' => '',
'parent_folder_id' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'folder' => [
'name' => '',
'parent_folder_id' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/folders/');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/folders/' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"folder": {
"name": "",
"parent_folder_id": ""
}
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"folder": {
"name": "",
"parent_folder_id": ""
}
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"folder\": {\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/folders/", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/folders/"
payload = { "folder": {
"name": "",
"parent_folder_id": ""
} }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/folders/"
payload <- "{\n \"folder\": {\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n }\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"folder\": {\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n }\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/folders/') do |req|
req.body = "{\n \"folder\": {\n \"name\": \"\",\n \"parent_folder_id\": \"\"\n }\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/";
let payload = json!({"folder": json!({
"name": "",
"parent_folder_id": ""
})});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/folders/ \
--header 'content-type: application/json' \
--data '{
"folder": {
"name": "",
"parent_folder_id": ""
}
}'echo '{
"folder": {
"name": "",
"parent_folder_id": ""
}
}' | \
http POST {{baseUrl}}/folders/ \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "folder": {\n "name": "",\n "parent_folder_id": ""\n }\n}' \
--output-document \
- {{baseUrl}}/folders/import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["folder": [
"name": "",
"parent_folder_id": ""
]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"id": "fld_0000000000000000n1",
"name": "Folder 3",
"parent_folder_id": null,
"path": "/"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Unauthorized"
}
POST
Create a new HTML template
{{baseUrl}}/templates?desc=html
BODY json
{
"template": {
"allow_additional_properties": false,
"description": "",
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"template_type": "",
"webhook_url": ""
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/templates?desc=html");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/templates" {:query-params {:desc "html"}
:content-type :json
:form-params {:template {:allow_additional_properties false
:description ""
:editable_submissions false
:expiration_interval ""
:expire_after ""
:expire_submissions false
:footer_html ""
:header_html ""
:html ""
:name ""
:public_submissions false
:public_web_form false
:redirect_url ""
:scss ""
:slack_webhook_url ""
:template_type ""
:webhook_url ""}}})require "http/client"
url = "{{baseUrl}}/templates?desc=html"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/templates?desc=html"),
Content = new StringContent("{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/templates?desc=html");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/templates?desc=html"
payload := strings.NewReader("{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/templates?desc=html HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 468
{
"template": {
"allow_additional_properties": false,
"description": "",
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"template_type": "",
"webhook_url": ""
}
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/templates?desc=html")
.setHeader("content-type", "application/json")
.setBody("{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/templates?desc=html"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/templates?desc=html")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/templates?desc=html")
.header("content-type", "application/json")
.body("{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}")
.asString(); const data = JSON.stringify({
template: {
allow_additional_properties: false,
description: '',
editable_submissions: false,
expiration_interval: '',
expire_after: '',
expire_submissions: false,
footer_html: '',
header_html: '',
html: '',
name: '',
public_submissions: false,
public_web_form: false,
redirect_url: '',
scss: '',
slack_webhook_url: '',
template_type: '',
webhook_url: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/templates?desc=html');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/templates',
params: {desc: 'html'},
headers: {'content-type': 'application/json'},
data: {
template: {
allow_additional_properties: false,
description: '',
editable_submissions: false,
expiration_interval: '',
expire_after: '',
expire_submissions: false,
footer_html: '',
header_html: '',
html: '',
name: '',
public_submissions: false,
public_web_form: false,
redirect_url: '',
scss: '',
slack_webhook_url: '',
template_type: '',
webhook_url: ''
}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/templates?desc=html';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"template":{"allow_additional_properties":false,"description":"","editable_submissions":false,"expiration_interval":"","expire_after":"","expire_submissions":false,"footer_html":"","header_html":"","html":"","name":"","public_submissions":false,"public_web_form":false,"redirect_url":"","scss":"","slack_webhook_url":"","template_type":"","webhook_url":""}}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/templates?desc=html',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "template": {\n "allow_additional_properties": false,\n "description": "",\n "editable_submissions": false,\n "expiration_interval": "",\n "expire_after": "",\n "expire_submissions": false,\n "footer_html": "",\n "header_html": "",\n "html": "",\n "name": "",\n "public_submissions": false,\n "public_web_form": false,\n "redirect_url": "",\n "scss": "",\n "slack_webhook_url": "",\n "template_type": "",\n "webhook_url": ""\n }\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/templates?desc=html")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/templates?desc=html',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
template: {
allow_additional_properties: false,
description: '',
editable_submissions: false,
expiration_interval: '',
expire_after: '',
expire_submissions: false,
footer_html: '',
header_html: '',
html: '',
name: '',
public_submissions: false,
public_web_form: false,
redirect_url: '',
scss: '',
slack_webhook_url: '',
template_type: '',
webhook_url: ''
}
}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/templates',
qs: {desc: 'html'},
headers: {'content-type': 'application/json'},
body: {
template: {
allow_additional_properties: false,
description: '',
editable_submissions: false,
expiration_interval: '',
expire_after: '',
expire_submissions: false,
footer_html: '',
header_html: '',
html: '',
name: '',
public_submissions: false,
public_web_form: false,
redirect_url: '',
scss: '',
slack_webhook_url: '',
template_type: '',
webhook_url: ''
}
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/templates');
req.query({
desc: 'html'
});
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
template: {
allow_additional_properties: false,
description: '',
editable_submissions: false,
expiration_interval: '',
expire_after: '',
expire_submissions: false,
footer_html: '',
header_html: '',
html: '',
name: '',
public_submissions: false,
public_web_form: false,
redirect_url: '',
scss: '',
slack_webhook_url: '',
template_type: '',
webhook_url: ''
}
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/templates',
params: {desc: 'html'},
headers: {'content-type': 'application/json'},
data: {
template: {
allow_additional_properties: false,
description: '',
editable_submissions: false,
expiration_interval: '',
expire_after: '',
expire_submissions: false,
footer_html: '',
header_html: '',
html: '',
name: '',
public_submissions: false,
public_web_form: false,
redirect_url: '',
scss: '',
slack_webhook_url: '',
template_type: '',
webhook_url: ''
}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/templates?desc=html';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"template":{"allow_additional_properties":false,"description":"","editable_submissions":false,"expiration_interval":"","expire_after":"","expire_submissions":false,"footer_html":"","header_html":"","html":"","name":"","public_submissions":false,"public_web_form":false,"redirect_url":"","scss":"","slack_webhook_url":"","template_type":"","webhook_url":""}}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"template": @{ @"allow_additional_properties": @NO, @"description": @"", @"editable_submissions": @NO, @"expiration_interval": @"", @"expire_after": @"", @"expire_submissions": @NO, @"footer_html": @"", @"header_html": @"", @"html": @"", @"name": @"", @"public_submissions": @NO, @"public_web_form": @NO, @"redirect_url": @"", @"scss": @"", @"slack_webhook_url": @"", @"template_type": @"", @"webhook_url": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/templates?desc=html"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/templates?desc=html" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/templates?desc=html",
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([
'template' => [
'allow_additional_properties' => null,
'description' => '',
'editable_submissions' => null,
'expiration_interval' => '',
'expire_after' => '',
'expire_submissions' => null,
'footer_html' => '',
'header_html' => '',
'html' => '',
'name' => '',
'public_submissions' => null,
'public_web_form' => null,
'redirect_url' => '',
'scss' => '',
'slack_webhook_url' => '',
'template_type' => '',
'webhook_url' => ''
]
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/templates?desc=html', [
'body' => '{
"template": {
"allow_additional_properties": false,
"description": "",
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"template_type": "",
"webhook_url": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/templates');
$request->setMethod(HTTP_METH_POST);
$request->setQueryData([
'desc' => 'html'
]);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'template' => [
'allow_additional_properties' => null,
'description' => '',
'editable_submissions' => null,
'expiration_interval' => '',
'expire_after' => '',
'expire_submissions' => null,
'footer_html' => '',
'header_html' => '',
'html' => '',
'name' => '',
'public_submissions' => null,
'public_web_form' => null,
'redirect_url' => '',
'scss' => '',
'slack_webhook_url' => '',
'template_type' => '',
'webhook_url' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'template' => [
'allow_additional_properties' => null,
'description' => '',
'editable_submissions' => null,
'expiration_interval' => '',
'expire_after' => '',
'expire_submissions' => null,
'footer_html' => '',
'header_html' => '',
'html' => '',
'name' => '',
'public_submissions' => null,
'public_web_form' => null,
'redirect_url' => '',
'scss' => '',
'slack_webhook_url' => '',
'template_type' => '',
'webhook_url' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/templates');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setQuery(new http\QueryString([
'desc' => 'html'
]));
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/templates?desc=html' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"template": {
"allow_additional_properties": false,
"description": "",
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"template_type": "",
"webhook_url": ""
}
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/templates?desc=html' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"template": {
"allow_additional_properties": false,
"description": "",
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"template_type": "",
"webhook_url": ""
}
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/templates?desc=html", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/templates"
querystring = {"desc":"html"}
payload = { "template": {
"allow_additional_properties": False,
"description": "",
"editable_submissions": False,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": False,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": False,
"public_web_form": False,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"template_type": "",
"webhook_url": ""
} }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/templates"
queryString <- list(desc = "html")
payload <- "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/templates?desc=html")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/templates') do |req|
req.params['desc'] = 'html'
req.body = "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/templates";
let querystring = [
("desc", "html"),
];
let payload = json!({"template": json!({
"allow_additional_properties": false,
"description": "",
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"template_type": "",
"webhook_url": ""
})});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.query(&querystring)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url '{{baseUrl}}/templates?desc=html' \
--header 'content-type: application/json' \
--data '{
"template": {
"allow_additional_properties": false,
"description": "",
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"template_type": "",
"webhook_url": ""
}
}'echo '{
"template": {
"allow_additional_properties": false,
"description": "",
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"template_type": "",
"webhook_url": ""
}
}' | \
http POST '{{baseUrl}}/templates?desc=html' \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "template": {\n "allow_additional_properties": false,\n "description": "",\n "editable_submissions": false,\n "expiration_interval": "",\n "expire_after": "",\n "expire_submissions": false,\n "footer_html": "",\n "header_html": "",\n "html": "",\n "name": "",\n "public_submissions": false,\n "public_web_form": false,\n "redirect_url": "",\n "scss": "",\n "slack_webhook_url": "",\n "template_type": "",\n "webhook_url": ""\n }\n}' \
--output-document \
- '{{baseUrl}}/templates?desc=html'import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["template": [
"allow_additional_properties": false,
"description": "",
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"template_type": "",
"webhook_url": ""
]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/templates?desc=html")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"allow_additional_properties": false,
"description": "HTML template created via API",
"document_filename": null,
"document_processed": false,
"document_state": "pending",
"document_url": null,
"editable_submissions": false,
"expiration_interval": "days",
"expire_after": 7,
"expire_submissions": false,
"id": "tpl_000000000000000004",
"locked": false,
"name": "Test HTML Template",
"page_count": 1,
"page_dimensions": null,
"parent_folder_id": null,
"path": "/",
"permanent_document_url": null,
"public_submissions": false,
"public_web_form": false,
"redirect_url": null,
"slack_webhook_url": null,
"template_type": "html",
"webhook_url": null
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Unauthorized"
}
POST
Create a new PDF template from a cached presign upload
{{baseUrl}}/templates?desc=cached_upload
BODY json
{
"template": {
"allow_additional_properties": false,
"description": "",
"document": {
"id": "",
"metadata": {
"filename": "",
"mime_type": "",
"size": 0
},
"storage": ""
},
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"template_type": "",
"webhook_url": ""
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/templates?desc=cached_upload");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"document\": {\n \"id\": \"\",\n \"metadata\": {\n \"filename\": \"\",\n \"mime_type\": \"\",\n \"size\": 0\n },\n \"storage\": \"\"\n },\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/templates" {:query-params {:desc "cached_upload"}
:content-type :json
:form-params {:template {:allow_additional_properties false
:description ""
:document {:id ""
:metadata {:filename ""
:mime_type ""
:size 0}
:storage ""}
:editable_submissions false
:expiration_interval ""
:expire_after ""
:expire_submissions false
:footer_html ""
:header_html ""
:html ""
:name ""
:public_submissions false
:public_web_form false
:redirect_url ""
:scss ""
:slack_webhook_url ""
:template_type ""
:webhook_url ""}}})require "http/client"
url = "{{baseUrl}}/templates?desc=cached_upload"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"document\": {\n \"id\": \"\",\n \"metadata\": {\n \"filename\": \"\",\n \"mime_type\": \"\",\n \"size\": 0\n },\n \"storage\": \"\"\n },\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/templates?desc=cached_upload"),
Content = new StringContent("{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"document\": {\n \"id\": \"\",\n \"metadata\": {\n \"filename\": \"\",\n \"mime_type\": \"\",\n \"size\": 0\n },\n \"storage\": \"\"\n },\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/templates?desc=cached_upload");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"document\": {\n \"id\": \"\",\n \"metadata\": {\n \"filename\": \"\",\n \"mime_type\": \"\",\n \"size\": 0\n },\n \"storage\": \"\"\n },\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/templates?desc=cached_upload"
payload := strings.NewReader("{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"document\": {\n \"id\": \"\",\n \"metadata\": {\n \"filename\": \"\",\n \"mime_type\": \"\",\n \"size\": 0\n },\n \"storage\": \"\"\n },\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/templates?desc=cached_upload HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 625
{
"template": {
"allow_additional_properties": false,
"description": "",
"document": {
"id": "",
"metadata": {
"filename": "",
"mime_type": "",
"size": 0
},
"storage": ""
},
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"template_type": "",
"webhook_url": ""
}
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/templates?desc=cached_upload")
.setHeader("content-type", "application/json")
.setBody("{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"document\": {\n \"id\": \"\",\n \"metadata\": {\n \"filename\": \"\",\n \"mime_type\": \"\",\n \"size\": 0\n },\n \"storage\": \"\"\n },\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/templates?desc=cached_upload"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"document\": {\n \"id\": \"\",\n \"metadata\": {\n \"filename\": \"\",\n \"mime_type\": \"\",\n \"size\": 0\n },\n \"storage\": \"\"\n },\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"document\": {\n \"id\": \"\",\n \"metadata\": {\n \"filename\": \"\",\n \"mime_type\": \"\",\n \"size\": 0\n },\n \"storage\": \"\"\n },\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/templates?desc=cached_upload")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/templates?desc=cached_upload")
.header("content-type", "application/json")
.body("{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"document\": {\n \"id\": \"\",\n \"metadata\": {\n \"filename\": \"\",\n \"mime_type\": \"\",\n \"size\": 0\n },\n \"storage\": \"\"\n },\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}")
.asString(); const data = JSON.stringify({
template: {
allow_additional_properties: false,
description: '',
document: {
id: '',
metadata: {
filename: '',
mime_type: '',
size: 0
},
storage: ''
},
editable_submissions: false,
expiration_interval: '',
expire_after: '',
expire_submissions: false,
footer_html: '',
header_html: '',
html: '',
name: '',
public_submissions: false,
public_web_form: false,
redirect_url: '',
scss: '',
slack_webhook_url: '',
template_type: '',
webhook_url: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/templates?desc=cached_upload');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/templates',
params: {desc: 'cached_upload'},
headers: {'content-type': 'application/json'},
data: {
template: {
allow_additional_properties: false,
description: '',
document: {id: '', metadata: {filename: '', mime_type: '', size: 0}, storage: ''},
editable_submissions: false,
expiration_interval: '',
expire_after: '',
expire_submissions: false,
footer_html: '',
header_html: '',
html: '',
name: '',
public_submissions: false,
public_web_form: false,
redirect_url: '',
scss: '',
slack_webhook_url: '',
template_type: '',
webhook_url: ''
}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/templates?desc=cached_upload';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"template":{"allow_additional_properties":false,"description":"","document":{"id":"","metadata":{"filename":"","mime_type":"","size":0},"storage":""},"editable_submissions":false,"expiration_interval":"","expire_after":"","expire_submissions":false,"footer_html":"","header_html":"","html":"","name":"","public_submissions":false,"public_web_form":false,"redirect_url":"","scss":"","slack_webhook_url":"","template_type":"","webhook_url":""}}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/templates?desc=cached_upload',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "template": {\n "allow_additional_properties": false,\n "description": "",\n "document": {\n "id": "",\n "metadata": {\n "filename": "",\n "mime_type": "",\n "size": 0\n },\n "storage": ""\n },\n "editable_submissions": false,\n "expiration_interval": "",\n "expire_after": "",\n "expire_submissions": false,\n "footer_html": "",\n "header_html": "",\n "html": "",\n "name": "",\n "public_submissions": false,\n "public_web_form": false,\n "redirect_url": "",\n "scss": "",\n "slack_webhook_url": "",\n "template_type": "",\n "webhook_url": ""\n }\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"document\": {\n \"id\": \"\",\n \"metadata\": {\n \"filename\": \"\",\n \"mime_type\": \"\",\n \"size\": 0\n },\n \"storage\": \"\"\n },\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/templates?desc=cached_upload")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/templates?desc=cached_upload',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
template: {
allow_additional_properties: false,
description: '',
document: {id: '', metadata: {filename: '', mime_type: '', size: 0}, storage: ''},
editable_submissions: false,
expiration_interval: '',
expire_after: '',
expire_submissions: false,
footer_html: '',
header_html: '',
html: '',
name: '',
public_submissions: false,
public_web_form: false,
redirect_url: '',
scss: '',
slack_webhook_url: '',
template_type: '',
webhook_url: ''
}
}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/templates',
qs: {desc: 'cached_upload'},
headers: {'content-type': 'application/json'},
body: {
template: {
allow_additional_properties: false,
description: '',
document: {id: '', metadata: {filename: '', mime_type: '', size: 0}, storage: ''},
editable_submissions: false,
expiration_interval: '',
expire_after: '',
expire_submissions: false,
footer_html: '',
header_html: '',
html: '',
name: '',
public_submissions: false,
public_web_form: false,
redirect_url: '',
scss: '',
slack_webhook_url: '',
template_type: '',
webhook_url: ''
}
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/templates');
req.query({
desc: 'cached_upload'
});
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
template: {
allow_additional_properties: false,
description: '',
document: {
id: '',
metadata: {
filename: '',
mime_type: '',
size: 0
},
storage: ''
},
editable_submissions: false,
expiration_interval: '',
expire_after: '',
expire_submissions: false,
footer_html: '',
header_html: '',
html: '',
name: '',
public_submissions: false,
public_web_form: false,
redirect_url: '',
scss: '',
slack_webhook_url: '',
template_type: '',
webhook_url: ''
}
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/templates',
params: {desc: 'cached_upload'},
headers: {'content-type': 'application/json'},
data: {
template: {
allow_additional_properties: false,
description: '',
document: {id: '', metadata: {filename: '', mime_type: '', size: 0}, storage: ''},
editable_submissions: false,
expiration_interval: '',
expire_after: '',
expire_submissions: false,
footer_html: '',
header_html: '',
html: '',
name: '',
public_submissions: false,
public_web_form: false,
redirect_url: '',
scss: '',
slack_webhook_url: '',
template_type: '',
webhook_url: ''
}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/templates?desc=cached_upload';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"template":{"allow_additional_properties":false,"description":"","document":{"id":"","metadata":{"filename":"","mime_type":"","size":0},"storage":""},"editable_submissions":false,"expiration_interval":"","expire_after":"","expire_submissions":false,"footer_html":"","header_html":"","html":"","name":"","public_submissions":false,"public_web_form":false,"redirect_url":"","scss":"","slack_webhook_url":"","template_type":"","webhook_url":""}}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"template": @{ @"allow_additional_properties": @NO, @"description": @"", @"document": @{ @"id": @"", @"metadata": @{ @"filename": @"", @"mime_type": @"", @"size": @0 }, @"storage": @"" }, @"editable_submissions": @NO, @"expiration_interval": @"", @"expire_after": @"", @"expire_submissions": @NO, @"footer_html": @"", @"header_html": @"", @"html": @"", @"name": @"", @"public_submissions": @NO, @"public_web_form": @NO, @"redirect_url": @"", @"scss": @"", @"slack_webhook_url": @"", @"template_type": @"", @"webhook_url": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/templates?desc=cached_upload"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/templates?desc=cached_upload" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"document\": {\n \"id\": \"\",\n \"metadata\": {\n \"filename\": \"\",\n \"mime_type\": \"\",\n \"size\": 0\n },\n \"storage\": \"\"\n },\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/templates?desc=cached_upload",
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([
'template' => [
'allow_additional_properties' => null,
'description' => '',
'document' => [
'id' => '',
'metadata' => [
'filename' => '',
'mime_type' => '',
'size' => 0
],
'storage' => ''
],
'editable_submissions' => null,
'expiration_interval' => '',
'expire_after' => '',
'expire_submissions' => null,
'footer_html' => '',
'header_html' => '',
'html' => '',
'name' => '',
'public_submissions' => null,
'public_web_form' => null,
'redirect_url' => '',
'scss' => '',
'slack_webhook_url' => '',
'template_type' => '',
'webhook_url' => ''
]
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/templates?desc=cached_upload', [
'body' => '{
"template": {
"allow_additional_properties": false,
"description": "",
"document": {
"id": "",
"metadata": {
"filename": "",
"mime_type": "",
"size": 0
},
"storage": ""
},
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"template_type": "",
"webhook_url": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/templates');
$request->setMethod(HTTP_METH_POST);
$request->setQueryData([
'desc' => 'cached_upload'
]);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'template' => [
'allow_additional_properties' => null,
'description' => '',
'document' => [
'id' => '',
'metadata' => [
'filename' => '',
'mime_type' => '',
'size' => 0
],
'storage' => ''
],
'editable_submissions' => null,
'expiration_interval' => '',
'expire_after' => '',
'expire_submissions' => null,
'footer_html' => '',
'header_html' => '',
'html' => '',
'name' => '',
'public_submissions' => null,
'public_web_form' => null,
'redirect_url' => '',
'scss' => '',
'slack_webhook_url' => '',
'template_type' => '',
'webhook_url' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'template' => [
'allow_additional_properties' => null,
'description' => '',
'document' => [
'id' => '',
'metadata' => [
'filename' => '',
'mime_type' => '',
'size' => 0
],
'storage' => ''
],
'editable_submissions' => null,
'expiration_interval' => '',
'expire_after' => '',
'expire_submissions' => null,
'footer_html' => '',
'header_html' => '',
'html' => '',
'name' => '',
'public_submissions' => null,
'public_web_form' => null,
'redirect_url' => '',
'scss' => '',
'slack_webhook_url' => '',
'template_type' => '',
'webhook_url' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/templates');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setQuery(new http\QueryString([
'desc' => 'cached_upload'
]));
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/templates?desc=cached_upload' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"template": {
"allow_additional_properties": false,
"description": "",
"document": {
"id": "",
"metadata": {
"filename": "",
"mime_type": "",
"size": 0
},
"storage": ""
},
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"template_type": "",
"webhook_url": ""
}
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/templates?desc=cached_upload' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"template": {
"allow_additional_properties": false,
"description": "",
"document": {
"id": "",
"metadata": {
"filename": "",
"mime_type": "",
"size": 0
},
"storage": ""
},
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"template_type": "",
"webhook_url": ""
}
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"document\": {\n \"id\": \"\",\n \"metadata\": {\n \"filename\": \"\",\n \"mime_type\": \"\",\n \"size\": 0\n },\n \"storage\": \"\"\n },\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/templates?desc=cached_upload", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/templates"
querystring = {"desc":"cached_upload"}
payload = { "template": {
"allow_additional_properties": False,
"description": "",
"document": {
"id": "",
"metadata": {
"filename": "",
"mime_type": "",
"size": 0
},
"storage": ""
},
"editable_submissions": False,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": False,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": False,
"public_web_form": False,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"template_type": "",
"webhook_url": ""
} }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/templates"
queryString <- list(desc = "cached_upload")
payload <- "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"document\": {\n \"id\": \"\",\n \"metadata\": {\n \"filename\": \"\",\n \"mime_type\": \"\",\n \"size\": 0\n },\n \"storage\": \"\"\n },\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/templates?desc=cached_upload")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"document\": {\n \"id\": \"\",\n \"metadata\": {\n \"filename\": \"\",\n \"mime_type\": \"\",\n \"size\": 0\n },\n \"storage\": \"\"\n },\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/templates') do |req|
req.params['desc'] = 'cached_upload'
req.body = "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"document\": {\n \"id\": \"\",\n \"metadata\": {\n \"filename\": \"\",\n \"mime_type\": \"\",\n \"size\": 0\n },\n \"storage\": \"\"\n },\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/templates";
let querystring = [
("desc", "cached_upload"),
];
let payload = json!({"template": json!({
"allow_additional_properties": false,
"description": "",
"document": json!({
"id": "",
"metadata": json!({
"filename": "",
"mime_type": "",
"size": 0
}),
"storage": ""
}),
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"template_type": "",
"webhook_url": ""
})});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.query(&querystring)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url '{{baseUrl}}/templates?desc=cached_upload' \
--header 'content-type: application/json' \
--data '{
"template": {
"allow_additional_properties": false,
"description": "",
"document": {
"id": "",
"metadata": {
"filename": "",
"mime_type": "",
"size": 0
},
"storage": ""
},
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"template_type": "",
"webhook_url": ""
}
}'echo '{
"template": {
"allow_additional_properties": false,
"description": "",
"document": {
"id": "",
"metadata": {
"filename": "",
"mime_type": "",
"size": 0
},
"storage": ""
},
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"template_type": "",
"webhook_url": ""
}
}' | \
http POST '{{baseUrl}}/templates?desc=cached_upload' \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "template": {\n "allow_additional_properties": false,\n "description": "",\n "document": {\n "id": "",\n "metadata": {\n "filename": "",\n "mime_type": "",\n "size": 0\n },\n "storage": ""\n },\n "editable_submissions": false,\n "expiration_interval": "",\n "expire_after": "",\n "expire_submissions": false,\n "footer_html": "",\n "header_html": "",\n "html": "",\n "name": "",\n "public_submissions": false,\n "public_web_form": false,\n "redirect_url": "",\n "scss": "",\n "slack_webhook_url": "",\n "template_type": "",\n "webhook_url": ""\n }\n}' \
--output-document \
- '{{baseUrl}}/templates?desc=cached_upload'import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["template": [
"allow_additional_properties": false,
"description": "",
"document": [
"id": "",
"metadata": [
"filename": "",
"mime_type": "",
"size": 0
],
"storage": ""
],
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"template_type": "",
"webhook_url": ""
]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/templates?desc=cached_upload")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"allow_additional_properties": false,
"description": null,
"document_filename": "fw8ben-presigned.pdf",
"document_processed": false,
"document_state": "pending",
"document_url": "/uploads/test/cache/b6903dbfb15c13bbad1444c35064df9e",
"editable_submissions": false,
"expiration_interval": "days",
"expire_after": 7,
"expire_submissions": false,
"id": "tpl_000000000000000004",
"locked": false,
"name": "Test Template Presigned",
"page_count": 0,
"page_dimensions": null,
"parent_folder_id": null,
"path": "/",
"permanent_document_url": null,
"public_submissions": false,
"public_web_form": false,
"redirect_url": null,
"slack_webhook_url": null,
"template_type": "pdf",
"webhook_url": null
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Unauthorized"
}
POST
Create a new PDF template with a form POST file upload
{{baseUrl}}/templates
BODY multipartForm
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/templates");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: multipart/form-data; boundary=---011000010111000001101001");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[document]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[name]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[parent_folder_id]\"\r\n\r\n\r\n-----011000010111000001101001--\r\n");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/templates" {:multipart [{:name "template[document]"
:content ""} {:name "template[name]"
:content ""} {:name "template[parent_folder_id]"
:content ""}]})require "http/client"
url = "{{baseUrl}}/templates"
headers = HTTP::Headers{
"content-type" => "multipart/form-data; boundary=---011000010111000001101001"
}
reqBody = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[document]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[name]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[parent_folder_id]\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/templates"),
Content = new MultipartFormDataContent
{
new StringContent("")
{
Headers =
{
ContentDisposition = new ContentDispositionHeaderValue("form-data")
{
Name = "template[document]",
}
}
},
new StringContent("")
{
Headers =
{
ContentDisposition = new ContentDispositionHeaderValue("form-data")
{
Name = "template[name]",
}
}
},
new StringContent("")
{
Headers =
{
ContentDisposition = new ContentDispositionHeaderValue("form-data")
{
Name = "template[parent_folder_id]",
}
}
},
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/templates");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001");
request.AddParameter("multipart/form-data; boundary=---011000010111000001101001", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[document]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[name]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[parent_folder_id]\"\r\n\r\n\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/templates"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[document]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[name]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[parent_folder_id]\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/templates HTTP/1.1
Content-Type: multipart/form-data; boundary=---011000010111000001101001
Host: example.com
Content-Length: 319
-----011000010111000001101001
Content-Disposition: form-data; name="template[document]"
-----011000010111000001101001
Content-Disposition: form-data; name="template[name]"
-----011000010111000001101001
Content-Disposition: form-data; name="template[parent_folder_id]"
-----011000010111000001101001--
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/templates")
.setHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.setBody("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[document]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[name]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[parent_folder_id]\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/templates"))
.header("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.method("POST", HttpRequest.BodyPublishers.ofString("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[document]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[name]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[parent_folder_id]\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001");
RequestBody body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[document]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[name]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[parent_folder_id]\"\r\n\r\n\r\n-----011000010111000001101001--\r\n");
Request request = new Request.Builder()
.url("{{baseUrl}}/templates")
.post(body)
.addHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/templates")
.header("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[document]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[name]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[parent_folder_id]\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
.asString(); const data = new FormData();
data.append('template[document]', '');
data.append('template[name]', '');
data.append('template[parent_folder_id]', '');
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/templates');
xhr.send(data);import axios from 'axios';
const form = new FormData();
form.append('template[document]', '');
form.append('template[name]', '');
form.append('template[parent_folder_id]', '');
const options = {
method: 'POST',
url: '{{baseUrl}}/templates',
headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
data: '[form]'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/templates';
const form = new FormData();
form.append('template[document]', '');
form.append('template[name]', '');
form.append('template[parent_folder_id]', '');
const options = {method: 'POST'};
options.body = form;
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const form = new FormData();
form.append('template[document]', '');
form.append('template[name]', '');
form.append('template[parent_folder_id]', '');
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/templates',
method: 'POST',
headers: {},
processData: false,
contentType: false,
mimeType: 'multipart/form-data',
data: form
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001")
val body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[document]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[name]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[parent_folder_id]\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
val request = Request.Builder()
.url("{{baseUrl}}/templates")
.post(body)
.addHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/templates',
headers: {
'content-type': 'multipart/form-data; boundary=---011000010111000001101001'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write('-----011000010111000001101001\r\nContent-Disposition: form-data; name="template[document]"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name="template[name]"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name="template[parent_folder_id]"\r\n\r\n\r\n-----011000010111000001101001--\r\n');
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/templates',
headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
formData: {
'template[document]': '',
'template[name]': '',
'template[parent_folder_id]': ''
}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/templates');
req.headers({
'content-type': 'multipart/form-data; boundary=---011000010111000001101001'
});
req.multipart([]);
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/templates',
headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
data: '-----011000010111000001101001\r\nContent-Disposition: form-data; name="template[document]"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name="template[name]"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name="template[parent_folder_id]"\r\n\r\n\r\n-----011000010111000001101001--\r\n'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const FormData = require('form-data');
const fetch = require('node-fetch');
const formData = new FormData();
formData.append('template[document]', '');
formData.append('template[name]', '');
formData.append('template[parent_folder_id]', '');
const url = '{{baseUrl}}/templates';
const options = {method: 'POST'};
options.body = formData;
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"multipart/form-data; boundary=---011000010111000001101001" };
NSArray *parameters = @[ @{ @"name": @"template[document]", @"value": @"" },
@{ @"name": @"template[name]", @"value": @"" },
@{ @"name": @"template[parent_folder_id]", @"value": @"" } ];
NSString *boundary = @"---011000010111000001101001";
NSError *error;
NSMutableString *body = [NSMutableString string];
for (NSDictionary *param in parameters) {
[body appendFormat:@"--%@\r\n", boundary];
if (param[@"fileName"]) {
[body appendFormat:@"Content-Disposition:form-data; name=\"%@\"; filename=\"%@\"\r\n", param[@"name"], param[@"fileName"]];
[body appendFormat:@"Content-Type: %@\r\n\r\n", param[@"contentType"]];
[body appendFormat:@"%@", [NSString stringWithContentsOfFile:param[@"fileName"] encoding:NSUTF8StringEncoding error:&error]];
if (error) {
NSLog(@"%@", error);
}
} else {
[body appendFormat:@"Content-Disposition:form-data; name=\"%@\"\r\n\r\n", param[@"name"]];
[body appendFormat:@"%@", param[@"value"]];
}
}
[body appendFormat:@"\r\n--%@--\r\n", boundary];
NSData *postData = [body dataUsingEncoding:NSUTF8StringEncoding];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/templates"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/templates" in
let headers = Header.add (Header.init ()) "content-type" "multipart/form-data; boundary=---011000010111000001101001" in
let body = Cohttp_lwt_body.of_string "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[document]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[name]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[parent_folder_id]\"\r\n\r\n\r\n-----011000010111000001101001--\r\n" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/templates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[document]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[name]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[parent_folder_id]\"\r\n\r\n\r\n-----011000010111000001101001--\r\n",
CURLOPT_HTTPHEADER => [
"content-type: multipart/form-data; boundary=---011000010111000001101001"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/templates', [
'headers' => [
'content-type' => 'multipart/form-data; boundary=---011000010111000001101001',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/templates');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'multipart/form-data; boundary=---011000010111000001101001'
]);
$request->setBody('-----011000010111000001101001
Content-Disposition: form-data; name="template[document]"
-----011000010111000001101001
Content-Disposition: form-data; name="template[name]"
-----011000010111000001101001
Content-Disposition: form-data; name="template[parent_folder_id]"
-----011000010111000001101001--
');
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}addForm(null, null);
$request->setRequestUrl('{{baseUrl}}/templates');
$request->setRequestMethod('POST');
$request->setBody($body);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/templates' -Method POST -Headers $headers -ContentType 'multipart/form-data; boundary=---011000010111000001101001' -Body '-----011000010111000001101001
Content-Disposition: form-data; name="template[document]"
-----011000010111000001101001
Content-Disposition: form-data; name="template[name]"
-----011000010111000001101001
Content-Disposition: form-data; name="template[parent_folder_id]"
-----011000010111000001101001--
'$headers=@{}
$headers.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/templates' -Method POST -Headers $headers -ContentType 'multipart/form-data; boundary=---011000010111000001101001' -Body '-----011000010111000001101001
Content-Disposition: form-data; name="template[document]"
-----011000010111000001101001
Content-Disposition: form-data; name="template[name]"
-----011000010111000001101001
Content-Disposition: form-data; name="template[parent_folder_id]"
-----011000010111000001101001--
'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[document]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[name]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[parent_folder_id]\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
headers = { 'content-type': "multipart/form-data; boundary=---011000010111000001101001" }
conn.request("POST", "/baseUrl/templates", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/templates"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[document]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[name]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[parent_folder_id]\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
headers = {"content-type": "multipart/form-data; boundary=---011000010111000001101001"}
response = requests.post(url, data=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/templates"
payload <- "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[document]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[name]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[parent_folder_id]\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
encode <- "multipart"
response <- VERB("POST", url, body = payload, content_type("multipart/form-data"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'multipart/form-data; boundary=---011000010111000001101001'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[document]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[name]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[parent_folder_id]\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'multipart/form-data; boundary=---011000010111000001101001'}
)
response = conn.post('/baseUrl/templates') do |req|
req.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[document]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[name]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template[parent_folder_id]\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/templates";
let form = reqwest::multipart::Form::new()
.text("template[document]", "")
.text("template[name]", "")
.text("template[parent_folder_id]", "");
let mut headers = reqwest::header::HeaderMap::new();
let client = reqwest::Client::new();
let response = client.post(url)
.multipart(form)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/templates \
--header 'content-type: multipart/form-data' \
--form 'template[document]=' \
--form 'template[name]=' \
--form 'template[parent_folder_id]='echo '-----011000010111000001101001
Content-Disposition: form-data; name="template[document]"
-----011000010111000001101001
Content-Disposition: form-data; name="template[name]"
-----011000010111000001101001
Content-Disposition: form-data; name="template[parent_folder_id]"
-----011000010111000001101001--
' | \
http POST {{baseUrl}}/templates \
content-type:'multipart/form-data; boundary=---011000010111000001101001'wget --quiet \
--method POST \
--header 'content-type: multipart/form-data; boundary=---011000010111000001101001' \
--body-data '-----011000010111000001101001\r\nContent-Disposition: form-data; name="template[document]"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name="template[name]"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name="template[parent_folder_id]"\r\n\r\n\r\n-----011000010111000001101001--\r\n' \
--output-document \
- {{baseUrl}}/templatesimport Foundation
let headers = ["content-type": "multipart/form-data; boundary=---011000010111000001101001"]
let parameters = [
[
"name": "template[document]",
"value": ""
],
[
"name": "template[name]",
"value": ""
],
[
"name": "template[parent_folder_id]",
"value": ""
]
]
let boundary = "---011000010111000001101001"
var body = ""
var error: NSError? = nil
for param in parameters {
let paramName = param["name"]!
body += "--\(boundary)\r\n"
body += "Content-Disposition:form-data; name=\"\(paramName)\""
if let filename = param["fileName"] {
let contentType = param["content-type"]!
let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8)
if (error != nil) {
print(error as Any)
}
body += "; filename=\"\(filename)\"\r\n"
body += "Content-Type: \(contentType)\r\n\r\n"
body += fileContent
} else if let paramValue = param["value"] {
body += "\r\n\r\n\(paramValue)"
}
}
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/templates")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"allow_additional_properties": false,
"description": null,
"document_filename": "fw8ben.pdf",
"document_processed": false,
"document_state": "pending",
"document_url": "/cache/cached_upload.pdf",
"editable_submissions": false,
"expiration_interval": "days",
"expire_after": 7,
"expire_submissions": false,
"id": "tpl_000000000000000004",
"locked": false,
"name": "Test Template",
"page_count": 0,
"page_dimensions": null,
"parent_folder_id": "fld_000000000000000001",
"path": "/Folder",
"permanent_document_url": null,
"public_submissions": false,
"public_web_form": false,
"redirect_url": null,
"slack_webhook_url": null,
"template_type": "pdf",
"webhook_url": null
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Unauthorized"
}
POST
Create a new custom file from a cached presign upload
{{baseUrl}}/custom_files
BODY json
{
"cache_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/custom_files");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"cache_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/custom_files" {:content-type :json
:form-params {:cache_id ""}})require "http/client"
url = "{{baseUrl}}/custom_files"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"cache_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/custom_files"),
Content = new StringContent("{\n \"cache_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/custom_files");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"cache_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/custom_files"
payload := strings.NewReader("{\n \"cache_id\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/custom_files HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 20
{
"cache_id": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/custom_files")
.setHeader("content-type", "application/json")
.setBody("{\n \"cache_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/custom_files"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"cache_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"cache_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/custom_files")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/custom_files")
.header("content-type", "application/json")
.body("{\n \"cache_id\": \"\"\n}")
.asString(); const data = JSON.stringify({
cache_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/custom_files');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/custom_files',
headers: {'content-type': 'application/json'},
data: {cache_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/custom_files';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"cache_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/custom_files',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "cache_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"cache_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/custom_files")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/custom_files',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({cache_id: ''}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/custom_files',
headers: {'content-type': 'application/json'},
body: {cache_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/custom_files');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
cache_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/custom_files',
headers: {'content-type': 'application/json'},
data: {cache_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/custom_files';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"cache_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"cache_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/custom_files"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/custom_files" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"cache_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/custom_files",
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([
'cache_id' => ''
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/custom_files', [
'body' => '{
"cache_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/custom_files');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'cache_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'cache_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/custom_files');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/custom_files' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"cache_id": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/custom_files' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"cache_id": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"cache_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/custom_files", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/custom_files"
payload = { "cache_id": "" }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/custom_files"
payload <- "{\n \"cache_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/custom_files")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"cache_id\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/custom_files') do |req|
req.body = "{\n \"cache_id\": \"\"\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/custom_files";
let payload = json!({"cache_id": ""});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/custom_files \
--header 'content-type: application/json' \
--data '{
"cache_id": ""
}'echo '{
"cache_id": ""
}' | \
http POST {{baseUrl}}/custom_files \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "cache_id": ""\n}' \
--output-document \
- {{baseUrl}}/custom_filesimport Foundation
let headers = ["content-type": "application/json"]
let parameters = ["cache_id": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/custom_files")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"custom_file": {
"id": "cfi_000000000000000001",
"url": "/uploads/test/store/acc_000000000000000001/custom_files/cfi_000000000000000001.pdf"
},
"status": "success"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Unauthorized"
}
POST
Creates a new data request token for form authentication
{{baseUrl}}/data_requests/:data_request_id/tokens
QUERY PARAMS
data_request_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/data_requests/:data_request_id/tokens");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/data_requests/:data_request_id/tokens")require "http/client"
url = "{{baseUrl}}/data_requests/:data_request_id/tokens"
response = HTTP::Client.post url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/data_requests/:data_request_id/tokens"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/data_requests/:data_request_id/tokens");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/data_requests/:data_request_id/tokens"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/data_requests/:data_request_id/tokens HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/data_requests/:data_request_id/tokens")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/data_requests/:data_request_id/tokens"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/data_requests/:data_request_id/tokens")
.post(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/data_requests/:data_request_id/tokens")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/data_requests/:data_request_id/tokens');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/data_requests/:data_request_id/tokens'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/data_requests/:data_request_id/tokens';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/data_requests/:data_request_id/tokens',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/data_requests/:data_request_id/tokens")
.post(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/data_requests/:data_request_id/tokens',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/data_requests/:data_request_id/tokens'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/data_requests/:data_request_id/tokens');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/data_requests/:data_request_id/tokens'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/data_requests/:data_request_id/tokens';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/data_requests/:data_request_id/tokens"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/data_requests/:data_request_id/tokens" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/data_requests/:data_request_id/tokens",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/data_requests/:data_request_id/tokens');
echo $response->getBody();setUrl('{{baseUrl}}/data_requests/:data_request_id/tokens');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/data_requests/:data_request_id/tokens');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/data_requests/:data_request_id/tokens' -Method POST $response = Invoke-RestMethod -Uri '{{baseUrl}}/data_requests/:data_request_id/tokens' -Method POST import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/data_requests/:data_request_id/tokens")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/data_requests/:data_request_id/tokens"
response = requests.post(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/data_requests/:data_request_id/tokens"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/data_requests/:data_request_id/tokens")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/data_requests/:data_request_id/tokens') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/data_requests/:data_request_id/tokens";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/data_requests/:data_request_id/tokenshttp POST {{baseUrl}}/data_requests/:data_request_id/tokenswget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/data_requests/:data_request_id/tokensimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/data_requests/:data_request_id/tokens")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"status": "success",
"token": {
"data_request_url": "http://app.docspring.local/data_requests/drq_000000000000000001?token_id=000000000000000001&token_secret=ABCDEF01234567890",
"expires_at": "2018-10-20T14:00:00Z",
"id": "000000000000000001",
"secret": "ABCDEF01234567890"
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Unauthorized"
}
DELETE
Delete a folder
{{baseUrl}}/folders/:folder_id
QUERY PARAMS
folder_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/folders/:folder_id")require "http/client"
url = "{{baseUrl}}/folders/:folder_id"
response = HTTP::Client.delete url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/folders/:folder_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/folders/:folder_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}DELETE /baseUrl/folders/:folder_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/folders/:folder_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/folders/:folder_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.delete("{{baseUrl}}/folders/:folder_id")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/folders/:folder_id');
xhr.send(data);import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/folders/:folder_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/folders/:folder_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/folders/:folder_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id")
.delete(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/folders/:folder_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {method: 'DELETE', url: '{{baseUrl}}/folders/:folder_id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/folders/:folder_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {method: 'DELETE', url: '{{baseUrl}}/folders/:folder_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/folders/:folder_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/folders/:folder_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('DELETE', '{{baseUrl}}/folders/:folder_id');
echo $response->getBody();setUrl('{{baseUrl}}/folders/:folder_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/folders/:folder_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/folders/:folder_id' -Method DELETE $response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id' -Method DELETE import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/folders/:folder_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/folders/:folder_id"
response = requests.delete(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/folders/:folder_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/:folder_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/folders/:folder_id') do |req|
end
puts response.status
puts response.bodyuse std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/folders/:folder_idhttp DELETE {{baseUrl}}/folders/:folder_idwget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/folders/:folder_idimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"id": "fld_000000000000000001",
"name": "Folder 1",
"parent_folder_id": null,
"path": "/"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Unauthorized"
}
DELETE
Expire a PDF submission
{{baseUrl}}/submissions/:submission_id
QUERY PARAMS
submission_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/submissions/:submission_id");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/submissions/:submission_id")require "http/client"
url = "{{baseUrl}}/submissions/:submission_id"
response = HTTP::Client.delete url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/submissions/:submission_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/submissions/:submission_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/submissions/:submission_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}DELETE /baseUrl/submissions/:submission_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/submissions/:submission_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/submissions/:submission_id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/submissions/:submission_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.delete("{{baseUrl}}/submissions/:submission_id")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/submissions/:submission_id');
xhr.send(data);import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/submissions/:submission_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/submissions/:submission_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/submissions/:submission_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/submissions/:submission_id")
.delete(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/submissions/:submission_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/submissions/:submission_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/submissions/:submission_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/submissions/:submission_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/submissions/:submission_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/submissions/:submission_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/submissions/:submission_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/submissions/:submission_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('DELETE', '{{baseUrl}}/submissions/:submission_id');
echo $response->getBody();setUrl('{{baseUrl}}/submissions/:submission_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/submissions/:submission_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/submissions/:submission_id' -Method DELETE $response = Invoke-RestMethod -Uri '{{baseUrl}}/submissions/:submission_id' -Method DELETE import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/submissions/:submission_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/submissions/:submission_id"
response = requests.delete(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/submissions/:submission_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/submissions/:submission_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/submissions/:submission_id') do |req|
end
puts response.status
puts response.bodyuse std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/submissions/:submission_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/submissions/:submission_idhttp DELETE {{baseUrl}}/submissions/:submission_idwget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/submissions/:submission_idimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/submissions/:submission_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"actions": [
{
"action_category": "file_upload",
"action_type": "aws_s3_upload",
"id": "sba_000000000000000001",
"integration_id": "aci_000000000000000001",
"result_data": {
"s3_bucket": "docspring-custom-s3-test",
"s3_key": "templates/tpl_eGc5CmFbPnCCmerqsx/sub_gzYpKDYFqEHxzca4kK.pdf",
"s3_region": "us-east-1",
"s3_url": "https://docspring-custom-s3-test.s3.amazonaws.com/templates/tpl_eGc5CmFbPnCCmerqsx/sub_gzYpKDYFqEHxzca4kK.pdf"
},
"state": "processed"
}
],
"batch_id": null,
"data_requests": [],
"download_url": null,
"editable": false,
"expired": true,
"expires_at": "2018-10-20T13:00:00Z",
"id": "sub_000000000000000001",
"json_schema_errors": [],
"metadata": {
"qux": "abc",
"user_id": 42
},
"password": null,
"pdf_hash": "bbc369dd471442006963e3244a1b43610e066165c09770978221f91bd7ace8f5",
"permanent_download_url": null,
"processed_at": "2020-05-14T02:00:00Z",
"state": "processed",
"template_id": "tpl_000000000000000001",
"test": true,
"truncated_text": {
"first_name": [
"F. Scott Fitzgerald"
]
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Invalid API token secret"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "You must use a live API token to expire a submission.",
"status": "error"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Submission not found.",
"status": "error"
}
DELETE
Expire a combined submission
{{baseUrl}}/combined_submissions/:combined_submission_id
QUERY PARAMS
combined_submission_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/combined_submissions/:combined_submission_id");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/combined_submissions/:combined_submission_id")require "http/client"
url = "{{baseUrl}}/combined_submissions/:combined_submission_id"
response = HTTP::Client.delete url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/combined_submissions/:combined_submission_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/combined_submissions/:combined_submission_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/combined_submissions/:combined_submission_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}DELETE /baseUrl/combined_submissions/:combined_submission_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/combined_submissions/:combined_submission_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/combined_submissions/:combined_submission_id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/combined_submissions/:combined_submission_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.delete("{{baseUrl}}/combined_submissions/:combined_submission_id")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/combined_submissions/:combined_submission_id');
xhr.send(data);import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/combined_submissions/:combined_submission_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/combined_submissions/:combined_submission_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/combined_submissions/:combined_submission_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/combined_submissions/:combined_submission_id")
.delete(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/combined_submissions/:combined_submission_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/combined_submissions/:combined_submission_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/combined_submissions/:combined_submission_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/combined_submissions/:combined_submission_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/combined_submissions/:combined_submission_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/combined_submissions/:combined_submission_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/combined_submissions/:combined_submission_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/combined_submissions/:combined_submission_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('DELETE', '{{baseUrl}}/combined_submissions/:combined_submission_id');
echo $response->getBody();setUrl('{{baseUrl}}/combined_submissions/:combined_submission_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/combined_submissions/:combined_submission_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/combined_submissions/:combined_submission_id' -Method DELETE $response = Invoke-RestMethod -Uri '{{baseUrl}}/combined_submissions/:combined_submission_id' -Method DELETE import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/combined_submissions/:combined_submission_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/combined_submissions/:combined_submission_id"
response = requests.delete(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/combined_submissions/:combined_submission_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/combined_submissions/:combined_submission_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/combined_submissions/:combined_submission_id') do |req|
end
puts response.status
puts response.bodyuse std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/combined_submissions/:combined_submission_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/combined_submissions/:combined_submission_idhttp DELETE {{baseUrl}}/combined_submissions/:combined_submission_idwget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/combined_submissions/:combined_submission_idimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/combined_submissions/:combined_submission_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"actions": [
{
"action_category": "file_upload",
"action_type": "aws_s3_upload",
"id": "csa_000000000000000001",
"integration_id": "aci_000000000000000001",
"result_data": {
"s3_bucket": "docspring-custom-s3-test",
"s3_key": "acc_1234/2018/combined_submissions/20181005090010-com_1234.pdf",
"s3_region": "us-east-1",
"s3_url": "https://docspring-custom-s3-test.s3.amazonaws.com/acc_1234/2018/combined_submissions/20181005090010-com_1234.pdf"
},
"state": "processed"
}
],
"download_url": null,
"error_message": null,
"expired": true,
"expires_at": "2018-10-20T13:00:00Z",
"expires_in": 300,
"id": "com_000000000000000001",
"metadata": {
"qux": "abc",
"user_id": 42
},
"password": "p@ssword",
"pdf_hash": "12342342471442006963e3244a1b43610e066165c09770978221f91bd7ace8f5",
"processed_at": "2020-05-14T02:00:00Z",
"source_pdfs": [],
"state": "processed",
"submission_ids": [
"sub_000000000000000001",
"sub_000000000000000002"
]
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Unauthorized"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "You must use a live API token to expire a combined submission.",
"status": "error"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Combined submission not found.",
"status": "error"
}
GET
Fetch the JSON schema for a template
{{baseUrl}}/templates/:template_id/schema
QUERY PARAMS
template_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/templates/:template_id/schema");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/templates/:template_id/schema")require "http/client"
url = "{{baseUrl}}/templates/:template_id/schema"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/templates/:template_id/schema"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/templates/:template_id/schema");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/templates/:template_id/schema"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/templates/:template_id/schema HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/templates/:template_id/schema")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/templates/:template_id/schema"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/templates/:template_id/schema")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/templates/:template_id/schema")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/templates/:template_id/schema');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/templates/:template_id/schema'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/templates/:template_id/schema';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/templates/:template_id/schema',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/templates/:template_id/schema")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/templates/:template_id/schema',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/templates/:template_id/schema'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/templates/:template_id/schema');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/templates/:template_id/schema'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/templates/:template_id/schema';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/templates/:template_id/schema"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/templates/:template_id/schema" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/templates/:template_id/schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/templates/:template_id/schema');
echo $response->getBody();setUrl('{{baseUrl}}/templates/:template_id/schema');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/templates/:template_id/schema');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/templates/:template_id/schema' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/templates/:template_id/schema' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/templates/:template_id/schema")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/templates/:template_id/schema"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/templates/:template_id/schema"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/templates/:template_id/schema")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/templates/:template_id/schema') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/templates/:template_id/schema";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/templates/:template_id/schemahttp GET {{baseUrl}}/templates/:template_id/schemawget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/templates/:template_id/schemaimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/templates/:template_id/schema")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {},
"description": "JSON Schema generated by DocSpring.com",
"id": "https://api.docspring.com/api/v1/templates/tpl_000000000000000001/schema.json",
"properties": {
"first_name": {
"title": "First Name",
"type": "string"
},
"last_name": {
"title": "Last Name",
"type": "string"
},
"phone_number": {
"title": "Phone Number",
"type": [
"string",
"null"
]
}
},
"required": [
"first_name",
"last_name"
],
"title": "Template 1",
"type": "object"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Unauthorized"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Template not found.",
"status": "error"
}
GET
Fetch the full template attributes
{{baseUrl}}/templates/:template_id?full=true
QUERY PARAMS
template_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/templates/:template_id?full=true");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/templates/:template_id" {:query-params {:full "true"}})require "http/client"
url = "{{baseUrl}}/templates/:template_id?full=true"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/templates/:template_id?full=true"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/templates/:template_id?full=true");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/templates/:template_id?full=true"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/templates/:template_id?full=true HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/templates/:template_id?full=true")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/templates/:template_id?full=true"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/templates/:template_id?full=true")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/templates/:template_id?full=true")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/templates/:template_id?full=true');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/templates/:template_id',
params: {full: 'true'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/templates/:template_id?full=true';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/templates/:template_id?full=true',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/templates/:template_id?full=true")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/templates/:template_id?full=true',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/templates/:template_id',
qs: {full: 'true'}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/templates/:template_id');
req.query({
full: 'true'
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/templates/:template_id',
params: {full: 'true'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/templates/:template_id?full=true';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/templates/:template_id?full=true"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/templates/:template_id?full=true" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/templates/:template_id?full=true",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/templates/:template_id?full=true');
echo $response->getBody();setUrl('{{baseUrl}}/templates/:template_id');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'full' => 'true'
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/templates/:template_id');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'full' => 'true'
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/templates/:template_id?full=true' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/templates/:template_id?full=true' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/templates/:template_id?full=true")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/templates/:template_id"
querystring = {"full":"true"}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/templates/:template_id"
queryString <- list(full = "true")
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/templates/:template_id?full=true")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/templates/:template_id') do |req|
req.params['full'] = 'true'
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/templates/:template_id";
let querystring = [
("full", "true"),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/templates/:template_id?full=true'http GET '{{baseUrl}}/templates/:template_id?full=true'wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/templates/:template_id?full=true'import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/templates/:template_id?full=true")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"allow_additional_properties": false,
"defaults": {
"characterSpacing": 0,
"checkColor": "444444",
"color": "444444",
"dateFormat": "%m/%d/%Y",
"dateTimeFormat": "%m/%d/%Y %H:%M:%S",
"fontSize": 11,
"opacity": 1,
"shapeBorderColor": "4A90E2",
"typeface": "Helvetica"
},
"demo": false,
"description": null,
"document_filename": "blank_pdf.pdf",
"document_md5": "1c32d785398e3a7eaab0e9b876903cc6",
"document_parse_error": false,
"document_processed": true,
"document_state": "processed",
"document_url": "/uploads/test/store/acc_000000000000000001/templates/tpl_000000000000000001/document/original-0000000000.pdf",
"editable_submissions": false,
"embed_domains": null,
"encrypt_pdfs": false,
"encrypt_pdfs_password": null,
"expiration_interval": "days",
"expire_after": 7,
"expire_submissions": true,
"field_order": [
[
1,
2,
3
]
],
"fields": {
"1": {
"displayType": "text",
"height": 80,
"name": "first_name",
"width": 200,
"x": 0,
"y": 0
},
"2": {
"displayType": "text",
"height": 80,
"name": "last_name",
"width": 200,
"x": 0,
"y": 100
},
"3": {
"displayType": "text",
"height": 80,
"name": "phone_number",
"width": 200,
"x": 0,
"y": 200
}
},
"first_template": false,
"footer_html": null,
"header_html": null,
"html": null,
"html_engine_options": {
"format": "Letter",
"landscape": false,
"marginBottom": "1in",
"marginLeft": "1in",
"marginRight": "1in",
"marginTop": "1in",
"scale": 1
},
"id": "tpl_000000000000000001",
"locked": false,
"name": "Template 1",
"page_count": 1,
"page_dimensions": [
[
612,
792
]
],
"parent_folder_id": null,
"path": "/",
"permanent_document_url": "http://app.docspring.local/templates/tpl_000000000000000001/original_pdf?token=123456789abcdef",
"public_submissions": false,
"public_web_form": false,
"redirect_url": null,
"scss": null,
"shared_field_data": {
"first_name": {
"fieldCount": 1,
"name": "first_name",
"required": true,
"type": "string"
},
"last_name": {
"fieldCount": 1,
"name": "last_name",
"required": true,
"type": "string"
},
"phone_number": {
"fieldCount": 1,
"name": "phone_number",
"required": false,
"type": "string"
}
},
"slack_webhook_url": null,
"template_type": "pdf",
"webhook_url": null
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Unauthorized"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Template not found.",
"status": "error"
}
POST
Generates a new PDF
{{baseUrl}}/templates/:template_id/submissions
QUERY PARAMS
template_id
BODY json
{
"css": "",
"data": {},
"data_requests": [
{
"auth_phone_number_hash": "",
"auth_provider": "",
"auth_second_factor_type": "",
"auth_session_id_hash": "",
"auth_session_started_at": "",
"auth_type": "",
"auth_user_id_hash": "",
"auth_username_hash": "",
"email": "",
"fields": [],
"metadata": {},
"name": "",
"order": 0
}
],
"expires_in": 0,
"field_overrides": {},
"html": "",
"metadata": {},
"password": "",
"test": false
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/templates/:template_id/submissions");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"css\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n }\n ],\n \"expires_in\": 0,\n \"field_overrides\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"password\": \"\",\n \"test\": false\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/templates/:template_id/submissions" {:content-type :json
:form-params {:css ""
:data {}
:data_requests [{:auth_phone_number_hash ""
:auth_provider ""
:auth_second_factor_type ""
:auth_session_id_hash ""
:auth_session_started_at ""
:auth_type ""
:auth_user_id_hash ""
:auth_username_hash ""
:email ""
:fields []
:metadata {}
:name ""
:order 0}]
:expires_in 0
:field_overrides {}
:html ""
:metadata {}
:password ""
:test false}})require "http/client"
url = "{{baseUrl}}/templates/:template_id/submissions"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"css\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n }\n ],\n \"expires_in\": 0,\n \"field_overrides\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"password\": \"\",\n \"test\": false\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/templates/:template_id/submissions"),
Content = new StringContent("{\n \"css\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n }\n ],\n \"expires_in\": 0,\n \"field_overrides\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"password\": \"\",\n \"test\": false\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/templates/:template_id/submissions");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"css\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n }\n ],\n \"expires_in\": 0,\n \"field_overrides\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"password\": \"\",\n \"test\": false\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/templates/:template_id/submissions"
payload := strings.NewReader("{\n \"css\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n }\n ],\n \"expires_in\": 0,\n \"field_overrides\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"password\": \"\",\n \"test\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/templates/:template_id/submissions HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 531
{
"css": "",
"data": {},
"data_requests": [
{
"auth_phone_number_hash": "",
"auth_provider": "",
"auth_second_factor_type": "",
"auth_session_id_hash": "",
"auth_session_started_at": "",
"auth_type": "",
"auth_user_id_hash": "",
"auth_username_hash": "",
"email": "",
"fields": [],
"metadata": {},
"name": "",
"order": 0
}
],
"expires_in": 0,
"field_overrides": {},
"html": "",
"metadata": {},
"password": "",
"test": false
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/templates/:template_id/submissions")
.setHeader("content-type", "application/json")
.setBody("{\n \"css\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n }\n ],\n \"expires_in\": 0,\n \"field_overrides\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"password\": \"\",\n \"test\": false\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/templates/:template_id/submissions"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"css\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n }\n ],\n \"expires_in\": 0,\n \"field_overrides\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"password\": \"\",\n \"test\": false\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"css\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n }\n ],\n \"expires_in\": 0,\n \"field_overrides\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"password\": \"\",\n \"test\": false\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/templates/:template_id/submissions")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/templates/:template_id/submissions")
.header("content-type", "application/json")
.body("{\n \"css\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n }\n ],\n \"expires_in\": 0,\n \"field_overrides\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"password\": \"\",\n \"test\": false\n}")
.asString(); const data = JSON.stringify({
css: '',
data: {},
data_requests: [
{
auth_phone_number_hash: '',
auth_provider: '',
auth_second_factor_type: '',
auth_session_id_hash: '',
auth_session_started_at: '',
auth_type: '',
auth_user_id_hash: '',
auth_username_hash: '',
email: '',
fields: [],
metadata: {},
name: '',
order: 0
}
],
expires_in: 0,
field_overrides: {},
html: '',
metadata: {},
password: '',
test: false
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/templates/:template_id/submissions');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/templates/:template_id/submissions',
headers: {'content-type': 'application/json'},
data: {
css: '',
data: {},
data_requests: [
{
auth_phone_number_hash: '',
auth_provider: '',
auth_second_factor_type: '',
auth_session_id_hash: '',
auth_session_started_at: '',
auth_type: '',
auth_user_id_hash: '',
auth_username_hash: '',
email: '',
fields: [],
metadata: {},
name: '',
order: 0
}
],
expires_in: 0,
field_overrides: {},
html: '',
metadata: {},
password: '',
test: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/templates/:template_id/submissions';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"css":"","data":{},"data_requests":[{"auth_phone_number_hash":"","auth_provider":"","auth_second_factor_type":"","auth_session_id_hash":"","auth_session_started_at":"","auth_type":"","auth_user_id_hash":"","auth_username_hash":"","email":"","fields":[],"metadata":{},"name":"","order":0}],"expires_in":0,"field_overrides":{},"html":"","metadata":{},"password":"","test":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/templates/:template_id/submissions',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "css": "",\n "data": {},\n "data_requests": [\n {\n "auth_phone_number_hash": "",\n "auth_provider": "",\n "auth_second_factor_type": "",\n "auth_session_id_hash": "",\n "auth_session_started_at": "",\n "auth_type": "",\n "auth_user_id_hash": "",\n "auth_username_hash": "",\n "email": "",\n "fields": [],\n "metadata": {},\n "name": "",\n "order": 0\n }\n ],\n "expires_in": 0,\n "field_overrides": {},\n "html": "",\n "metadata": {},\n "password": "",\n "test": false\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"css\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n }\n ],\n \"expires_in\": 0,\n \"field_overrides\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"password\": \"\",\n \"test\": false\n}")
val request = Request.Builder()
.url("{{baseUrl}}/templates/:template_id/submissions")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/templates/:template_id/submissions',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
css: '',
data: {},
data_requests: [
{
auth_phone_number_hash: '',
auth_provider: '',
auth_second_factor_type: '',
auth_session_id_hash: '',
auth_session_started_at: '',
auth_type: '',
auth_user_id_hash: '',
auth_username_hash: '',
email: '',
fields: [],
metadata: {},
name: '',
order: 0
}
],
expires_in: 0,
field_overrides: {},
html: '',
metadata: {},
password: '',
test: false
}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/templates/:template_id/submissions',
headers: {'content-type': 'application/json'},
body: {
css: '',
data: {},
data_requests: [
{
auth_phone_number_hash: '',
auth_provider: '',
auth_second_factor_type: '',
auth_session_id_hash: '',
auth_session_started_at: '',
auth_type: '',
auth_user_id_hash: '',
auth_username_hash: '',
email: '',
fields: [],
metadata: {},
name: '',
order: 0
}
],
expires_in: 0,
field_overrides: {},
html: '',
metadata: {},
password: '',
test: false
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/templates/:template_id/submissions');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
css: '',
data: {},
data_requests: [
{
auth_phone_number_hash: '',
auth_provider: '',
auth_second_factor_type: '',
auth_session_id_hash: '',
auth_session_started_at: '',
auth_type: '',
auth_user_id_hash: '',
auth_username_hash: '',
email: '',
fields: [],
metadata: {},
name: '',
order: 0
}
],
expires_in: 0,
field_overrides: {},
html: '',
metadata: {},
password: '',
test: false
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/templates/:template_id/submissions',
headers: {'content-type': 'application/json'},
data: {
css: '',
data: {},
data_requests: [
{
auth_phone_number_hash: '',
auth_provider: '',
auth_second_factor_type: '',
auth_session_id_hash: '',
auth_session_started_at: '',
auth_type: '',
auth_user_id_hash: '',
auth_username_hash: '',
email: '',
fields: [],
metadata: {},
name: '',
order: 0
}
],
expires_in: 0,
field_overrides: {},
html: '',
metadata: {},
password: '',
test: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/templates/:template_id/submissions';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"css":"","data":{},"data_requests":[{"auth_phone_number_hash":"","auth_provider":"","auth_second_factor_type":"","auth_session_id_hash":"","auth_session_started_at":"","auth_type":"","auth_user_id_hash":"","auth_username_hash":"","email":"","fields":[],"metadata":{},"name":"","order":0}],"expires_in":0,"field_overrides":{},"html":"","metadata":{},"password":"","test":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"css": @"",
@"data": @{ },
@"data_requests": @[ @{ @"auth_phone_number_hash": @"", @"auth_provider": @"", @"auth_second_factor_type": @"", @"auth_session_id_hash": @"", @"auth_session_started_at": @"", @"auth_type": @"", @"auth_user_id_hash": @"", @"auth_username_hash": @"", @"email": @"", @"fields": @[ ], @"metadata": @{ }, @"name": @"", @"order": @0 } ],
@"expires_in": @0,
@"field_overrides": @{ },
@"html": @"",
@"metadata": @{ },
@"password": @"",
@"test": @NO };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/templates/:template_id/submissions"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/templates/:template_id/submissions" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"css\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n }\n ],\n \"expires_in\": 0,\n \"field_overrides\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"password\": \"\",\n \"test\": false\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/templates/:template_id/submissions",
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([
'css' => '',
'data' => [
],
'data_requests' => [
[
'auth_phone_number_hash' => '',
'auth_provider' => '',
'auth_second_factor_type' => '',
'auth_session_id_hash' => '',
'auth_session_started_at' => '',
'auth_type' => '',
'auth_user_id_hash' => '',
'auth_username_hash' => '',
'email' => '',
'fields' => [
],
'metadata' => [
],
'name' => '',
'order' => 0
]
],
'expires_in' => 0,
'field_overrides' => [
],
'html' => '',
'metadata' => [
],
'password' => '',
'test' => null
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/templates/:template_id/submissions', [
'body' => '{
"css": "",
"data": {},
"data_requests": [
{
"auth_phone_number_hash": "",
"auth_provider": "",
"auth_second_factor_type": "",
"auth_session_id_hash": "",
"auth_session_started_at": "",
"auth_type": "",
"auth_user_id_hash": "",
"auth_username_hash": "",
"email": "",
"fields": [],
"metadata": {},
"name": "",
"order": 0
}
],
"expires_in": 0,
"field_overrides": {},
"html": "",
"metadata": {},
"password": "",
"test": false
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/templates/:template_id/submissions');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'css' => '',
'data' => [
],
'data_requests' => [
[
'auth_phone_number_hash' => '',
'auth_provider' => '',
'auth_second_factor_type' => '',
'auth_session_id_hash' => '',
'auth_session_started_at' => '',
'auth_type' => '',
'auth_user_id_hash' => '',
'auth_username_hash' => '',
'email' => '',
'fields' => [
],
'metadata' => [
],
'name' => '',
'order' => 0
]
],
'expires_in' => 0,
'field_overrides' => [
],
'html' => '',
'metadata' => [
],
'password' => '',
'test' => null
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'css' => '',
'data' => [
],
'data_requests' => [
[
'auth_phone_number_hash' => '',
'auth_provider' => '',
'auth_second_factor_type' => '',
'auth_session_id_hash' => '',
'auth_session_started_at' => '',
'auth_type' => '',
'auth_user_id_hash' => '',
'auth_username_hash' => '',
'email' => '',
'fields' => [
],
'metadata' => [
],
'name' => '',
'order' => 0
]
],
'expires_in' => 0,
'field_overrides' => [
],
'html' => '',
'metadata' => [
],
'password' => '',
'test' => null
]));
$request->setRequestUrl('{{baseUrl}}/templates/:template_id/submissions');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/templates/:template_id/submissions' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"css": "",
"data": {},
"data_requests": [
{
"auth_phone_number_hash": "",
"auth_provider": "",
"auth_second_factor_type": "",
"auth_session_id_hash": "",
"auth_session_started_at": "",
"auth_type": "",
"auth_user_id_hash": "",
"auth_username_hash": "",
"email": "",
"fields": [],
"metadata": {},
"name": "",
"order": 0
}
],
"expires_in": 0,
"field_overrides": {},
"html": "",
"metadata": {},
"password": "",
"test": false
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/templates/:template_id/submissions' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"css": "",
"data": {},
"data_requests": [
{
"auth_phone_number_hash": "",
"auth_provider": "",
"auth_second_factor_type": "",
"auth_session_id_hash": "",
"auth_session_started_at": "",
"auth_type": "",
"auth_user_id_hash": "",
"auth_username_hash": "",
"email": "",
"fields": [],
"metadata": {},
"name": "",
"order": 0
}
],
"expires_in": 0,
"field_overrides": {},
"html": "",
"metadata": {},
"password": "",
"test": false
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"css\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n }\n ],\n \"expires_in\": 0,\n \"field_overrides\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"password\": \"\",\n \"test\": false\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/templates/:template_id/submissions", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/templates/:template_id/submissions"
payload = {
"css": "",
"data": {},
"data_requests": [
{
"auth_phone_number_hash": "",
"auth_provider": "",
"auth_second_factor_type": "",
"auth_session_id_hash": "",
"auth_session_started_at": "",
"auth_type": "",
"auth_user_id_hash": "",
"auth_username_hash": "",
"email": "",
"fields": [],
"metadata": {},
"name": "",
"order": 0
}
],
"expires_in": 0,
"field_overrides": {},
"html": "",
"metadata": {},
"password": "",
"test": False
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/templates/:template_id/submissions"
payload <- "{\n \"css\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n }\n ],\n \"expires_in\": 0,\n \"field_overrides\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"password\": \"\",\n \"test\": false\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/templates/:template_id/submissions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"css\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n }\n ],\n \"expires_in\": 0,\n \"field_overrides\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"password\": \"\",\n \"test\": false\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/templates/:template_id/submissions') do |req|
req.body = "{\n \"css\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n }\n ],\n \"expires_in\": 0,\n \"field_overrides\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"password\": \"\",\n \"test\": false\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/templates/:template_id/submissions";
let payload = json!({
"css": "",
"data": json!({}),
"data_requests": (
json!({
"auth_phone_number_hash": "",
"auth_provider": "",
"auth_second_factor_type": "",
"auth_session_id_hash": "",
"auth_session_started_at": "",
"auth_type": "",
"auth_user_id_hash": "",
"auth_username_hash": "",
"email": "",
"fields": (),
"metadata": json!({}),
"name": "",
"order": 0
})
),
"expires_in": 0,
"field_overrides": json!({}),
"html": "",
"metadata": json!({}),
"password": "",
"test": false
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/templates/:template_id/submissions \
--header 'content-type: application/json' \
--data '{
"css": "",
"data": {},
"data_requests": [
{
"auth_phone_number_hash": "",
"auth_provider": "",
"auth_second_factor_type": "",
"auth_session_id_hash": "",
"auth_session_started_at": "",
"auth_type": "",
"auth_user_id_hash": "",
"auth_username_hash": "",
"email": "",
"fields": [],
"metadata": {},
"name": "",
"order": 0
}
],
"expires_in": 0,
"field_overrides": {},
"html": "",
"metadata": {},
"password": "",
"test": false
}'echo '{
"css": "",
"data": {},
"data_requests": [
{
"auth_phone_number_hash": "",
"auth_provider": "",
"auth_second_factor_type": "",
"auth_session_id_hash": "",
"auth_session_started_at": "",
"auth_type": "",
"auth_user_id_hash": "",
"auth_username_hash": "",
"email": "",
"fields": [],
"metadata": {},
"name": "",
"order": 0
}
],
"expires_in": 0,
"field_overrides": {},
"html": "",
"metadata": {},
"password": "",
"test": false
}' | \
http POST {{baseUrl}}/templates/:template_id/submissions \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "css": "",\n "data": {},\n "data_requests": [\n {\n "auth_phone_number_hash": "",\n "auth_provider": "",\n "auth_second_factor_type": "",\n "auth_session_id_hash": "",\n "auth_session_started_at": "",\n "auth_type": "",\n "auth_user_id_hash": "",\n "auth_username_hash": "",\n "email": "",\n "fields": [],\n "metadata": {},\n "name": "",\n "order": 0\n }\n ],\n "expires_in": 0,\n "field_overrides": {},\n "html": "",\n "metadata": {},\n "password": "",\n "test": false\n}' \
--output-document \
- {{baseUrl}}/templates/:template_id/submissionsimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"css": "",
"data": [],
"data_requests": [
[
"auth_phone_number_hash": "",
"auth_provider": "",
"auth_second_factor_type": "",
"auth_session_id_hash": "",
"auth_session_started_at": "",
"auth_type": "",
"auth_user_id_hash": "",
"auth_username_hash": "",
"email": "",
"fields": [],
"metadata": [],
"name": "",
"order": 0
]
],
"expires_in": 0,
"field_overrides": [],
"html": "",
"metadata": [],
"password": "",
"test": false
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/templates/:template_id/submissions")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"status": "success",
"submission": {
"actions": [],
"batch_id": null,
"data_requests": [],
"download_url": null,
"editable": null,
"expired": false,
"expires_at": null,
"id": "sub_000000000000000001",
"json_schema_errors": [],
"metadata": {
"bar": "baz",
"foo": 123
},
"password": null,
"pdf_hash": null,
"permanent_download_url": null,
"processed_at": null,
"state": "pending",
"template_id": "tpl_000000000000000001",
"test": false,
"truncated_text": {}
}
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "There was a problem with the JSON you submitted: unexpected character at line 1, column 25 in '{ \"first_name\": \"John\", last_name: \"Smith\" }",
"status": "error"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Invalid API token secret",
"status": "error"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"errors": [
"Your submission data did not contain a required property of 'last_name'"
],
"status": "error",
"submission": {
"actions": [],
"batch_id": null,
"data_requests": [],
"download_url": null,
"editable": null,
"expired": false,
"expires_at": null,
"id": "sub_000000000000000001",
"json_schema_errors": [
"Your submission data did not contain a required property of 'last_name'"
],
"metadata": {
"bar": "baz",
"foo": 123
},
"password": null,
"pdf_hash": null,
"permanent_download_url": null,
"processed_at": null,
"state": "invalid_data",
"template_id": "tpl_000000000000000001",
"test": false,
"truncated_text": {}
}
}
POST
Generates multiple PDFs (POST)
{{baseUrl}}/templates/:template_id/submissions/batch
QUERY PARAMS
template_id
BODY json
[
{}
]
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/templates/:template_id/submissions/batch");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "[\n {}\n]");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/templates/:template_id/submissions/batch" {:content-type :json
:form-params [{}]})require "http/client"
url = "{{baseUrl}}/templates/:template_id/submissions/batch"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "[\n {}\n]"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/templates/:template_id/submissions/batch"),
Content = new StringContent("[\n {}\n]")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/templates/:template_id/submissions/batch");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "[\n {}\n]", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/templates/:template_id/submissions/batch"
payload := strings.NewReader("[\n {}\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/templates/:template_id/submissions/batch HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 8
[
{}
]AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/templates/:template_id/submissions/batch")
.setHeader("content-type", "application/json")
.setBody("[\n {}\n]")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/templates/:template_id/submissions/batch"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("[\n {}\n]"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[\n {}\n]");
Request request = new Request.Builder()
.url("{{baseUrl}}/templates/:template_id/submissions/batch")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/templates/:template_id/submissions/batch")
.header("content-type", "application/json")
.body("[\n {}\n]")
.asString(); const data = JSON.stringify([
{}
]);
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/templates/:template_id/submissions/batch');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/templates/:template_id/submissions/batch',
headers: {'content-type': 'application/json'},
data: [{}]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/templates/:template_id/submissions/batch';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '[{}]'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/templates/:template_id/submissions/batch',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '[\n {}\n]'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "[\n {}\n]")
val request = Request.Builder()
.url("{{baseUrl}}/templates/:template_id/submissions/batch")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/templates/:template_id/submissions/batch',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify([{}]));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/templates/:template_id/submissions/batch',
headers: {'content-type': 'application/json'},
body: [{}],
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/templates/:template_id/submissions/batch');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send([
{}
]);
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/templates/:template_id/submissions/batch',
headers: {'content-type': 'application/json'},
data: [{}]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/templates/:template_id/submissions/batch';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '[{}]'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @[ @{ } ];
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/templates/:template_id/submissions/batch"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/templates/:template_id/submissions/batch" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "[\n {}\n]" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/templates/:template_id/submissions/batch",
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([
[
]
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/templates/:template_id/submissions/batch', [
'body' => '[
{}
]',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/templates/:template_id/submissions/batch');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
[
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
[
]
]));
$request->setRequestUrl('{{baseUrl}}/templates/:template_id/submissions/batch');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/templates/:template_id/submissions/batch' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{}
]'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/templates/:template_id/submissions/batch' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{}
]'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "[\n {}\n]"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/templates/:template_id/submissions/batch", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/templates/:template_id/submissions/batch"
payload = [{}]
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/templates/:template_id/submissions/batch"
payload <- "[\n {}\n]"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/templates/:template_id/submissions/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "[\n {}\n]"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/templates/:template_id/submissions/batch') do |req|
req.body = "[\n {}\n]"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/templates/:template_id/submissions/batch";
let payload = (json!({}));
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/templates/:template_id/submissions/batch \
--header 'content-type: application/json' \
--data '[
{}
]'echo '[
{}
]' | \
http POST {{baseUrl}}/templates/:template_id/submissions/batch \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '[\n {}\n]' \
--output-document \
- {{baseUrl}}/templates/:template_id/submissions/batchimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [[]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/templates/:template_id/submissions/batch")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
[
{
"status": "success",
"submission": {
"actions": [],
"batch_id": null,
"data_requests": [],
"download_url": null,
"editable": null,
"expired": false,
"expires_at": null,
"id": "sub_000000000000000001",
"json_schema_errors": [],
"metadata": {
"submission_number": 1
},
"password": null,
"pdf_hash": null,
"permanent_download_url": null,
"processed_at": null,
"state": "pending",
"template_id": "tpl_000000000000000001",
"test": false,
"truncated_text": {}
}
},
{
"status": "success",
"submission": {
"actions": [],
"batch_id": null,
"data_requests": [],
"download_url": null,
"editable": null,
"expired": false,
"expires_at": null,
"id": "sub_000000000000000002",
"json_schema_errors": [],
"metadata": {
"submission_number": 2
},
"password": null,
"pdf_hash": null,
"permanent_download_url": null,
"processed_at": null,
"state": "pending",
"template_id": "tpl_000000000000000001",
"test": false,
"truncated_text": {}
}
}
]RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "There was a problem with the JSON you submitted: unexpected character at line 1, column 25 in '{ \"first_name\": \"John\", last_name: \"Smith\" }",
"status": "error"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Invalid API token secret"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
[
{
"errors": [
"Your submission data did not contain a required property of 'last_name'"
],
"status": "error",
"submission": {
"actions": [],
"batch_id": null,
"data_requests": [],
"download_url": null,
"editable": null,
"expired": false,
"expires_at": null,
"id": "sub_000000000000000001",
"json_schema_errors": [
"Your submission data did not contain a required property of 'last_name'"
],
"metadata": {
"submission_number": 1
},
"password": null,
"pdf_hash": null,
"permanent_download_url": null,
"processed_at": null,
"state": "invalid_data",
"template_id": "tpl_000000000000000001",
"test": false,
"truncated_text": {}
}
},
{
"errors": [
"Your submission data did not contain a required property of 'first_name'"
],
"status": "error",
"submission": {
"actions": [],
"batch_id": null,
"data_requests": [],
"download_url": null,
"editable": null,
"expired": false,
"expires_at": null,
"id": "sub_000000000000000002",
"json_schema_errors": [
"Your submission data did not contain a required property of 'first_name'"
],
"metadata": {
"submission_number": 2
},
"password": null,
"pdf_hash": null,
"permanent_download_url": null,
"processed_at": null,
"state": "invalid_data",
"template_id": "tpl_000000000000000001",
"test": false,
"truncated_text": {}
}
}
]
POST
Generates multiple PDFs
{{baseUrl}}/submissions/batches
BODY json
{
"metadata": {},
"submissions": [
{
"css": "",
"data": {},
"html": "",
"metadata": {},
"template_id": "",
"test": false
}
],
"template_id": "",
"test": false
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/submissions/batches");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"metadata\": {},\n \"submissions\": [\n {\n \"css\": \"\",\n \"data\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"template_id\": \"\",\n \"test\": false\n }\n ],\n \"template_id\": \"\",\n \"test\": false\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/submissions/batches" {:content-type :json
:form-params {:metadata {}
:submissions [{:css ""
:data {}
:html ""
:metadata {}
:template_id ""
:test false}]
:template_id ""
:test false}})require "http/client"
url = "{{baseUrl}}/submissions/batches"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"metadata\": {},\n \"submissions\": [\n {\n \"css\": \"\",\n \"data\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"template_id\": \"\",\n \"test\": false\n }\n ],\n \"template_id\": \"\",\n \"test\": false\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/submissions/batches"),
Content = new StringContent("{\n \"metadata\": {},\n \"submissions\": [\n {\n \"css\": \"\",\n \"data\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"template_id\": \"\",\n \"test\": false\n }\n ],\n \"template_id\": \"\",\n \"test\": false\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/submissions/batches");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"metadata\": {},\n \"submissions\": [\n {\n \"css\": \"\",\n \"data\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"template_id\": \"\",\n \"test\": false\n }\n ],\n \"template_id\": \"\",\n \"test\": false\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/submissions/batches"
payload := strings.NewReader("{\n \"metadata\": {},\n \"submissions\": [\n {\n \"css\": \"\",\n \"data\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"template_id\": \"\",\n \"test\": false\n }\n ],\n \"template_id\": \"\",\n \"test\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/submissions/batches HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 214
{
"metadata": {},
"submissions": [
{
"css": "",
"data": {},
"html": "",
"metadata": {},
"template_id": "",
"test": false
}
],
"template_id": "",
"test": false
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/submissions/batches")
.setHeader("content-type", "application/json")
.setBody("{\n \"metadata\": {},\n \"submissions\": [\n {\n \"css\": \"\",\n \"data\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"template_id\": \"\",\n \"test\": false\n }\n ],\n \"template_id\": \"\",\n \"test\": false\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/submissions/batches"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"metadata\": {},\n \"submissions\": [\n {\n \"css\": \"\",\n \"data\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"template_id\": \"\",\n \"test\": false\n }\n ],\n \"template_id\": \"\",\n \"test\": false\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"metadata\": {},\n \"submissions\": [\n {\n \"css\": \"\",\n \"data\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"template_id\": \"\",\n \"test\": false\n }\n ],\n \"template_id\": \"\",\n \"test\": false\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/submissions/batches")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/submissions/batches")
.header("content-type", "application/json")
.body("{\n \"metadata\": {},\n \"submissions\": [\n {\n \"css\": \"\",\n \"data\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"template_id\": \"\",\n \"test\": false\n }\n ],\n \"template_id\": \"\",\n \"test\": false\n}")
.asString(); const data = JSON.stringify({
metadata: {},
submissions: [
{
css: '',
data: {},
html: '',
metadata: {},
template_id: '',
test: false
}
],
template_id: '',
test: false
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/submissions/batches');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/submissions/batches',
headers: {'content-type': 'application/json'},
data: {
metadata: {},
submissions: [{css: '', data: {}, html: '', metadata: {}, template_id: '', test: false}],
template_id: '',
test: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/submissions/batches';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"metadata":{},"submissions":[{"css":"","data":{},"html":"","metadata":{},"template_id":"","test":false}],"template_id":"","test":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/submissions/batches',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "metadata": {},\n "submissions": [\n {\n "css": "",\n "data": {},\n "html": "",\n "metadata": {},\n "template_id": "",\n "test": false\n }\n ],\n "template_id": "",\n "test": false\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"metadata\": {},\n \"submissions\": [\n {\n \"css\": \"\",\n \"data\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"template_id\": \"\",\n \"test\": false\n }\n ],\n \"template_id\": \"\",\n \"test\": false\n}")
val request = Request.Builder()
.url("{{baseUrl}}/submissions/batches")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/submissions/batches',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
metadata: {},
submissions: [{css: '', data: {}, html: '', metadata: {}, template_id: '', test: false}],
template_id: '',
test: false
}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/submissions/batches',
headers: {'content-type': 'application/json'},
body: {
metadata: {},
submissions: [{css: '', data: {}, html: '', metadata: {}, template_id: '', test: false}],
template_id: '',
test: false
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/submissions/batches');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
metadata: {},
submissions: [
{
css: '',
data: {},
html: '',
metadata: {},
template_id: '',
test: false
}
],
template_id: '',
test: false
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/submissions/batches',
headers: {'content-type': 'application/json'},
data: {
metadata: {},
submissions: [{css: '', data: {}, html: '', metadata: {}, template_id: '', test: false}],
template_id: '',
test: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/submissions/batches';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"metadata":{},"submissions":[{"css":"","data":{},"html":"","metadata":{},"template_id":"","test":false}],"template_id":"","test":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"metadata": @{ },
@"submissions": @[ @{ @"css": @"", @"data": @{ }, @"html": @"", @"metadata": @{ }, @"template_id": @"", @"test": @NO } ],
@"template_id": @"",
@"test": @NO };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/submissions/batches"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/submissions/batches" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"metadata\": {},\n \"submissions\": [\n {\n \"css\": \"\",\n \"data\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"template_id\": \"\",\n \"test\": false\n }\n ],\n \"template_id\": \"\",\n \"test\": false\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/submissions/batches",
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([
'metadata' => [
],
'submissions' => [
[
'css' => '',
'data' => [
],
'html' => '',
'metadata' => [
],
'template_id' => '',
'test' => null
]
],
'template_id' => '',
'test' => null
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/submissions/batches', [
'body' => '{
"metadata": {},
"submissions": [
{
"css": "",
"data": {},
"html": "",
"metadata": {},
"template_id": "",
"test": false
}
],
"template_id": "",
"test": false
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/submissions/batches');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'metadata' => [
],
'submissions' => [
[
'css' => '',
'data' => [
],
'html' => '',
'metadata' => [
],
'template_id' => '',
'test' => null
]
],
'template_id' => '',
'test' => null
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'metadata' => [
],
'submissions' => [
[
'css' => '',
'data' => [
],
'html' => '',
'metadata' => [
],
'template_id' => '',
'test' => null
]
],
'template_id' => '',
'test' => null
]));
$request->setRequestUrl('{{baseUrl}}/submissions/batches');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/submissions/batches' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"metadata": {},
"submissions": [
{
"css": "",
"data": {},
"html": "",
"metadata": {},
"template_id": "",
"test": false
}
],
"template_id": "",
"test": false
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/submissions/batches' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"metadata": {},
"submissions": [
{
"css": "",
"data": {},
"html": "",
"metadata": {},
"template_id": "",
"test": false
}
],
"template_id": "",
"test": false
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"metadata\": {},\n \"submissions\": [\n {\n \"css\": \"\",\n \"data\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"template_id\": \"\",\n \"test\": false\n }\n ],\n \"template_id\": \"\",\n \"test\": false\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/submissions/batches", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/submissions/batches"
payload = {
"metadata": {},
"submissions": [
{
"css": "",
"data": {},
"html": "",
"metadata": {},
"template_id": "",
"test": False
}
],
"template_id": "",
"test": False
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/submissions/batches"
payload <- "{\n \"metadata\": {},\n \"submissions\": [\n {\n \"css\": \"\",\n \"data\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"template_id\": \"\",\n \"test\": false\n }\n ],\n \"template_id\": \"\",\n \"test\": false\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/submissions/batches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"metadata\": {},\n \"submissions\": [\n {\n \"css\": \"\",\n \"data\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"template_id\": \"\",\n \"test\": false\n }\n ],\n \"template_id\": \"\",\n \"test\": false\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/submissions/batches') do |req|
req.body = "{\n \"metadata\": {},\n \"submissions\": [\n {\n \"css\": \"\",\n \"data\": {},\n \"html\": \"\",\n \"metadata\": {},\n \"template_id\": \"\",\n \"test\": false\n }\n ],\n \"template_id\": \"\",\n \"test\": false\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/submissions/batches";
let payload = json!({
"metadata": json!({}),
"submissions": (
json!({
"css": "",
"data": json!({}),
"html": "",
"metadata": json!({}),
"template_id": "",
"test": false
})
),
"template_id": "",
"test": false
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/submissions/batches \
--header 'content-type: application/json' \
--data '{
"metadata": {},
"submissions": [
{
"css": "",
"data": {},
"html": "",
"metadata": {},
"template_id": "",
"test": false
}
],
"template_id": "",
"test": false
}'echo '{
"metadata": {},
"submissions": [
{
"css": "",
"data": {},
"html": "",
"metadata": {},
"template_id": "",
"test": false
}
],
"template_id": "",
"test": false
}' | \
http POST {{baseUrl}}/submissions/batches \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "metadata": {},\n "submissions": [\n {\n "css": "",\n "data": {},\n "html": "",\n "metadata": {},\n "template_id": "",\n "test": false\n }\n ],\n "template_id": "",\n "test": false\n}' \
--output-document \
- {{baseUrl}}/submissions/batchesimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"metadata": [],
"submissions": [
[
"css": "",
"data": [],
"html": "",
"metadata": [],
"template_id": "",
"test": false
]
],
"template_id": "",
"test": false
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/submissions/batches")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"status": "error",
"submission_batch": {
"completion_percentage": 100,
"error_count": 1,
"id": "sbb_000000000000000001",
"metadata": {
"job_id": 54321
},
"pending_count": 0,
"processed_at": null,
"state": "error",
"total_count": 2
},
"submissions": [
{
"status": "valid_but_not_saved"
},
{
"errors": [
"Your submission data did not contain a required property of 'first_name'"
],
"status": "error",
"submission": {
"actions": [],
"batch_id": "sbb_000000000000000001",
"data_requests": [],
"download_url": null,
"editable": null,
"expired": false,
"expires_at": null,
"id": "sub_000000000000000001",
"json_schema_errors": [
"Your submission data did not contain a required property of 'first_name'"
],
"metadata": {
"submission_number": 2
},
"password": null,
"pdf_hash": null,
"permanent_download_url": null,
"processed_at": null,
"state": "invalid_data",
"template_id": "tpl_000000000000000001",
"test": true,
"truncated_text": {}
}
}
]
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"status": "success",
"submission_batch": {
"completion_percentage": 0,
"error_count": 0,
"id": "sbb_000000000000000001",
"metadata": {
"job_id": 54321
},
"pending_count": 2,
"processed_at": null,
"state": "pending",
"total_count": 2
},
"submissions": [
{
"status": "success",
"submission": {
"actions": [],
"batch_id": "sbb_000000000000000001",
"data_requests": [],
"download_url": null,
"editable": null,
"expired": false,
"expires_at": null,
"id": "sub_000000000000000001",
"json_schema_errors": [],
"metadata": {
"submission_number": 1
},
"password": null,
"pdf_hash": null,
"permanent_download_url": null,
"processed_at": null,
"state": "pending",
"template_id": "tpl_000000000000000001",
"test": false,
"truncated_text": {}
}
},
{
"status": "success",
"submission": {
"actions": [],
"batch_id": "sbb_000000000000000001",
"data_requests": [],
"download_url": null,
"editable": null,
"expired": false,
"expires_at": null,
"id": "sub_000000000000000002",
"json_schema_errors": [],
"metadata": {
"submission_number": 2
},
"password": null,
"pdf_hash": null,
"permanent_download_url": null,
"processed_at": null,
"state": "pending",
"template_id": "tpl_000000000000000001",
"test": true,
"truncated_text": {}
}
}
]
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "There was a problem with the JSON you submitted: unexpected character at line 1, column 25 in '{ \"first_name\": \"John\", last_name: \"Smith\" }",
"status": "error"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Invalid API token secret"
}
GET
Get a list of all combined submissions
{{baseUrl}}/combined_submissions
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/combined_submissions");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/combined_submissions")require "http/client"
url = "{{baseUrl}}/combined_submissions"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/combined_submissions"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/combined_submissions");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/combined_submissions"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/combined_submissions HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/combined_submissions")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/combined_submissions"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/combined_submissions")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/combined_submissions")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/combined_submissions');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/combined_submissions'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/combined_submissions';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/combined_submissions',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/combined_submissions")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/combined_submissions',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/combined_submissions'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/combined_submissions');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/combined_submissions'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/combined_submissions';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/combined_submissions"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/combined_submissions" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/combined_submissions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/combined_submissions');
echo $response->getBody();setUrl('{{baseUrl}}/combined_submissions');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/combined_submissions');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/combined_submissions' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/combined_submissions' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/combined_submissions")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/combined_submissions"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/combined_submissions"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/combined_submissions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/combined_submissions') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/combined_submissions";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/combined_submissionshttp GET {{baseUrl}}/combined_submissionswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/combined_submissionsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/combined_submissions")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
[
{
"actions": [],
"download_url": null,
"error_message": null,
"expired": false,
"expires_at": null,
"expires_in": null,
"id": "com_000000000000000001",
"metadata": {},
"password": null,
"pdf_hash": null,
"processed_at": null,
"source_pdfs": [],
"state": "pending",
"submission_ids": []
},
{
"actions": [],
"download_url": "https://example.com/combined_submissions/combined_submission.pdf",
"error_message": null,
"expired": false,
"expires_at": null,
"expires_in": null,
"id": "com_000000000000000002",
"metadata": {},
"password": null,
"pdf_hash": null,
"processed_at": "2023-01-05T14:00:00Z",
"source_pdfs": [],
"state": "processed",
"submission_ids": []
},
{
"actions": [],
"download_url": null,
"error_message": "Something went wrong",
"expired": false,
"expires_at": null,
"expires_in": 123,
"id": "com_000000000000000003",
"metadata": {},
"password": null,
"pdf_hash": null,
"processed_at": null,
"source_pdfs": [],
"state": "error",
"submission_ids": []
},
{
"actions": [],
"download_url": null,
"error_message": null,
"expired": true,
"expires_at": "2023-01-05T14:05:00Z",
"expires_in": 345,
"id": "com_000000000000000004",
"metadata": {},
"password": null,
"pdf_hash": null,
"processed_at": "2023-01-05T14:00:00Z",
"source_pdfs": [],
"state": "processed",
"submission_ids": []
}
]RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Unauthorized"
}
GET
Get a list of all folders
{{baseUrl}}/folders/
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/folders/")require "http/client"
url = "{{baseUrl}}/folders/"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/folders/"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/folders/");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/folders/ HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/folders/")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/folders/")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/folders/")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/folders/');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/folders/'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/folders/';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/folders/',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/folders/")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/folders/',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/folders/'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/folders/');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/folders/'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/folders/" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/folders/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/folders/');
echo $response->getBody();setUrl('{{baseUrl}}/folders/');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/folders/');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/folders/' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/folders/")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/folders/"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/folders/"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/folders/') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/folders/http GET {{baseUrl}}/folders/wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/folders/import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
[
{
"id": "fld_000000000000000003",
"name": "nested folder 1",
"parent_folder_id": "fld_000000000000000002",
"path": "/Folder 2"
},
{
"id": "fld_000000000000000002",
"name": "Folder 2",
"parent_folder_id": null,
"path": "/"
},
{
"id": "fld_000000000000000001",
"name": "Folder 1",
"parent_folder_id": null,
"path": "/"
}
]RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Unauthorized"
}
GET
Get a list of all templates
{{baseUrl}}/templates
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/templates");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/templates")require "http/client"
url = "{{baseUrl}}/templates"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/templates"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/templates");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/templates"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/templates HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/templates")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/templates"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/templates")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/templates")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/templates');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/templates'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/templates';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/templates',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/templates")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/templates',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/templates'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/templates');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/templates'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/templates';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/templates"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/templates" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/templates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/templates');
echo $response->getBody();setUrl('{{baseUrl}}/templates');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/templates');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/templates' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/templates' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/templates")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/templates"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/templates"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/templates') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/templates";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/templateshttp GET {{baseUrl}}/templateswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/templatesimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/templates")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
[
{
"allow_additional_properties": false,
"description": null,
"document_filename": "test-document.pdf",
"document_processed": true,
"document_state": "pending",
"document_url": "/uploads/test/store/templates/test/test-document.pdf",
"editable_submissions": false,
"expiration_interval": "days",
"expire_after": 7,
"expire_submissions": true,
"id": "tpl_000000000000000011",
"locked": false,
"name": "Sub Template 1",
"page_count": 3,
"page_dimensions": [
[
612,
792
],
[
792,
612
],
[
612,
792
]
],
"parent_folder_id": "fld_000000000000000001",
"path": "/Folder",
"permanent_document_url": "http://app.docspring.local/templates/tpl_000000000000000011/original_pdf?token=123456789abcdef",
"public_submissions": false,
"public_web_form": false,
"redirect_url": null,
"slack_webhook_url": null,
"template_type": "pdf",
"webhook_url": null
},
{
"allow_additional_properties": false,
"description": null,
"document_filename": null,
"document_processed": false,
"document_state": "pending",
"document_url": null,
"editable_submissions": false,
"expiration_interval": "days",
"expire_after": 7,
"expire_submissions": true,
"id": "tpl_000000000000000003",
"locked": false,
"name": "Template 3",
"page_count": 1,
"page_dimensions": null,
"parent_folder_id": null,
"path": "/",
"permanent_document_url": null,
"public_submissions": false,
"public_web_form": false,
"redirect_url": null,
"slack_webhook_url": null,
"template_type": "html",
"webhook_url": null
},
{
"allow_additional_properties": false,
"description": null,
"document_filename": "test-document.pdf",
"document_processed": true,
"document_state": "pending",
"document_url": "/uploads/test/store/templates/test/test-document.pdf",
"editable_submissions": false,
"expiration_interval": "days",
"expire_after": 7,
"expire_submissions": true,
"id": "tpl_000000000000000002",
"locked": false,
"name": "Template 2",
"page_count": 3,
"page_dimensions": [
[
612,
792
],
[
792,
612
],
[
612,
792
]
],
"parent_folder_id": null,
"path": "/",
"permanent_document_url": "http://app.docspring.local/templates/tpl_000000000000000002/original_pdf?token=123456789abcdef",
"public_submissions": false,
"public_web_form": false,
"redirect_url": null,
"slack_webhook_url": null,
"template_type": "pdf",
"webhook_url": null
},
{
"allow_additional_properties": false,
"description": null,
"document_filename": "blank_pdf.pdf",
"document_processed": true,
"document_state": "processed",
"document_url": "/uploads/test/store/acc_000000000000000001/templates/tpl_000000000000000001/document/original-0000000000.pdf",
"editable_submissions": false,
"expiration_interval": "days",
"expire_after": 7,
"expire_submissions": true,
"id": "tpl_000000000000000001",
"locked": false,
"name": "Template 1",
"page_count": 1,
"page_dimensions": [
[
612,
792
]
],
"parent_folder_id": null,
"path": "/",
"permanent_document_url": "http://app.docspring.local/templates/tpl_000000000000000001/original_pdf?token=123456789abcdef",
"public_submissions": false,
"public_web_form": false,
"redirect_url": null,
"slack_webhook_url": null,
"template_type": "pdf",
"webhook_url": null
}
]RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Unauthorized"
}
GET
Get a presigned URL so that you can upload a file to our AWS S3 bucket
{{baseUrl}}/uploads/presign
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/uploads/presign");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/uploads/presign")require "http/client"
url = "{{baseUrl}}/uploads/presign"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/uploads/presign"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/uploads/presign");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/uploads/presign"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/uploads/presign HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/uploads/presign")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/uploads/presign"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/uploads/presign")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/uploads/presign")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/uploads/presign');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/uploads/presign'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/uploads/presign';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/uploads/presign',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/uploads/presign")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/uploads/presign',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/uploads/presign'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/uploads/presign');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/uploads/presign'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/uploads/presign';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/uploads/presign"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/uploads/presign" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/uploads/presign",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/uploads/presign');
echo $response->getBody();setUrl('{{baseUrl}}/uploads/presign');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/uploads/presign');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/uploads/presign' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/uploads/presign' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/uploads/presign")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/uploads/presign"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/uploads/presign"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/uploads/presign")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/uploads/presign') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/uploads/presign";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/uploads/presignhttp GET {{baseUrl}}/uploads/presignwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/uploads/presignimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/uploads/presign")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"fields": {
"key": "ed9424dccf185f3835df4e9e1da0ca0b",
"policy": "eyJleHBpcmF0aW9uIjoiMjAxOS0xMC0wNVQxNDowMDowMFoiLCJjb25kaXRpb25zIjpbeyJidWNrZXQiOiJ0ZXN0LWJ1Y2tldCJ9LHsia2V5IjoiZWQ5NDI0ZGNjZjE4NWYzODM1ZGY0ZTllMWRhMGNhMGIifSx7IngtYW16LWNyZWRlbnRpYWwiOiIxMjM0NTY3ODkvMjAxOTEwMDUvdXMtZWFzdC0xL3MzL2F3czRfcmVxdWVzdCJ9LHsieC1hbXotYWxnb3JpdGhtIjoiQVdTNC1ITUFDLVNIQTI1NiJ9LHsieC1hbXotZGF0ZSI6IjIwMTkxMDA1VDEzMDAwMFoifV19",
"x-amz-algorithm": "AWS4-HMAC-SHA256",
"x-amz-credential": "123456789/20191005/us-east-1/s3/aws4_request",
"x-amz-date": "20191005T130000Z",
"x-amz-signature": "6b715e441bd7ea5beec87f8415230a600be6dfd76b8f89103137618dca959fac"
},
"headers": {},
"method": "post",
"url": "https://test-bucket.s3.amazonaws.com"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Unauthorized"
}
GET
List all submissions for a given template
{{baseUrl}}/templates/:template_id/submissions
QUERY PARAMS
template_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/templates/:template_id/submissions");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/templates/:template_id/submissions")require "http/client"
url = "{{baseUrl}}/templates/:template_id/submissions"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/templates/:template_id/submissions"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/templates/:template_id/submissions");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/templates/:template_id/submissions"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/templates/:template_id/submissions HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/templates/:template_id/submissions")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/templates/:template_id/submissions"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/templates/:template_id/submissions")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/templates/:template_id/submissions")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/templates/:template_id/submissions');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/templates/:template_id/submissions'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/templates/:template_id/submissions';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/templates/:template_id/submissions',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/templates/:template_id/submissions")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/templates/:template_id/submissions',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/templates/:template_id/submissions'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/templates/:template_id/submissions');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/templates/:template_id/submissions'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/templates/:template_id/submissions';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/templates/:template_id/submissions"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/templates/:template_id/submissions" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/templates/:template_id/submissions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/templates/:template_id/submissions');
echo $response->getBody();setUrl('{{baseUrl}}/templates/:template_id/submissions');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/templates/:template_id/submissions');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/templates/:template_id/submissions' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/templates/:template_id/submissions' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/templates/:template_id/submissions")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/templates/:template_id/submissions"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/templates/:template_id/submissions"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/templates/:template_id/submissions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/templates/:template_id/submissions') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/templates/:template_id/submissions";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/templates/:template_id/submissionshttp GET {{baseUrl}}/templates/:template_id/submissionswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/templates/:template_id/submissionsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/templates/:template_id/submissions")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"limit": 50,
"next_cursor": "sub_list_000014",
"submissions": [
{
"actions": [],
"batch_id": null,
"data": {
"first_name": "John C. D. Rom Laserdisk F. Scott Fitzgerald",
"last_name": "Smith",
"phone_number": "+11234567890"
},
"data_requests": [],
"download_url": "https://example.com/submissions/submission.pdf",
"editable": false,
"expired": false,
"expires_at": "2020-10-27T13:00:00Z",
"id": "sub_list_000011",
"json_schema_errors": [],
"metadata": {
"qux": "abc",
"user_id": 42
},
"password": null,
"pdf_hash": "bbc369dd471442006963e3244a1b43610e066165c09770978221f91bd7ace8f5",
"permanent_download_url": "http://app.docspring.local/submissions/sub_list_000011/download",
"processed_at": "2020-05-14T02:00:00Z",
"referrer": null,
"source": "api",
"state": "processed",
"template_id": "tpl_000000000000000002",
"test": false,
"truncated_text": {
"first_name": [
"F. Scott Fitzgerald"
]
}
},
{
"actions": [],
"batch_id": null,
"data": {
"first_name": "John C. D. Rom Laserdisk F. Scott Fitzgerald",
"last_name": "Smith",
"phone_number": "+11234567890"
},
"data_requests": [],
"download_url": "https://example.com/submissions/submission.pdf",
"editable": false,
"expired": false,
"expires_at": "2020-10-27T13:00:00Z",
"id": "sub_list_000012",
"json_schema_errors": [],
"metadata": {
"qux": "abc",
"user_id": 42
},
"password": null,
"pdf_hash": "bbc369dd471442006963e3244a1b43610e066165c09770978221f91bd7ace8f5",
"permanent_download_url": "http://app.docspring.local/submissions/sub_list_000012/download",
"processed_at": "2020-05-14T02:00:00Z",
"referrer": null,
"source": "api",
"state": "processed",
"template_id": "tpl_000000000000000002",
"test": false,
"truncated_text": {
"first_name": [
"F. Scott Fitzgerald"
]
}
},
{
"actions": [],
"batch_id": null,
"data": {
"first_name": "John C. D. Rom Laserdisk F. Scott Fitzgerald",
"last_name": "Smith",
"phone_number": "+11234567890"
},
"data_requests": [],
"download_url": "https://example.com/submissions/submission.pdf",
"editable": false,
"expired": false,
"expires_at": "2020-10-27T13:00:00Z",
"id": "sub_list_000013",
"json_schema_errors": [],
"metadata": {
"qux": "abc",
"user_id": 42
},
"password": null,
"pdf_hash": "bbc369dd471442006963e3244a1b43610e066165c09770978221f91bd7ace8f5",
"permanent_download_url": "http://app.docspring.local/submissions/sub_list_000013/download",
"processed_at": "2020-05-14T02:00:00Z",
"referrer": null,
"source": "api",
"state": "processed",
"template_id": "tpl_000000000000000002",
"test": false,
"truncated_text": {
"first_name": [
"F. Scott Fitzgerald"
]
}
},
{
"actions": [],
"batch_id": null,
"data": {
"first_name": "John C. D. Rom Laserdisk F. Scott Fitzgerald",
"last_name": "Smith",
"phone_number": "+11234567890"
},
"data_requests": [],
"download_url": "https://example.com/submissions/submission.pdf",
"editable": false,
"expired": false,
"expires_at": "2020-10-27T13:00:00Z",
"id": "sub_list_000014",
"json_schema_errors": [],
"metadata": {
"qux": "abc",
"user_id": 42
},
"password": null,
"pdf_hash": "bbc369dd471442006963e3244a1b43610e066165c09770978221f91bd7ace8f5",
"permanent_download_url": "http://app.docspring.local/submissions/sub_list_000014/download",
"processed_at": "2020-05-14T02:00:00Z",
"referrer": null,
"source": "api",
"state": "processed",
"template_id": "tpl_000000000000000002",
"test": false,
"truncated_text": {
"first_name": [
"F. Scott Fitzgerald"
]
}
}
]
}
GET
List all submissions
{{baseUrl}}/submissions
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/submissions");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/submissions")require "http/client"
url = "{{baseUrl}}/submissions"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/submissions"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/submissions");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/submissions"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/submissions HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/submissions")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/submissions"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/submissions")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/submissions")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/submissions');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/submissions'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/submissions';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/submissions',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/submissions")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/submissions',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/submissions'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/submissions');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/submissions'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/submissions';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/submissions"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/submissions" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/submissions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/submissions');
echo $response->getBody();setUrl('{{baseUrl}}/submissions');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/submissions');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/submissions' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/submissions' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/submissions")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/submissions"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/submissions"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/submissions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/submissions') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/submissions";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/submissionshttp GET {{baseUrl}}/submissionswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/submissionsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/submissions")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"limit": 3,
"next_cursor": "sub_list_000003",
"submissions": [
{
"actions": [],
"batch_id": null,
"data": {
"first_name": "John C. D. Rom Laserdisk F. Scott Fitzgerald",
"last_name": "Smith",
"phone_number": "+11234567890"
},
"data_requests": [],
"download_url": "https://example.com/submissions/submission.pdf",
"editable": false,
"expired": false,
"expires_at": "2020-10-27T13:00:00Z",
"id": "sub_list_000001",
"json_schema_errors": [],
"metadata": {
"qux": "abc",
"user_id": 42
},
"password": null,
"pdf_hash": "bbc369dd471442006963e3244a1b43610e066165c09770978221f91bd7ace8f5",
"permanent_download_url": "http://app.docspring.local/submissions/sub_list_000001/download",
"processed_at": "2020-05-14T02:00:00Z",
"referrer": null,
"source": "api",
"state": "processed",
"template_id": "tpl_000000000000000001",
"test": true,
"truncated_text": {
"first_name": [
"F. Scott Fitzgerald"
]
}
},
{
"actions": [],
"batch_id": null,
"data": {
"first_name": "John C. D. Rom Laserdisk F. Scott Fitzgerald",
"last_name": "Smith",
"phone_number": "+11234567890"
},
"data_requests": [],
"download_url": "https://example.com/submissions/submission.pdf",
"editable": false,
"expired": false,
"expires_at": "2020-10-27T13:00:00Z",
"id": "sub_list_000002",
"json_schema_errors": [],
"metadata": {
"qux": "abc",
"user_id": 42
},
"password": null,
"pdf_hash": "bbc369dd471442006963e3244a1b43610e066165c09770978221f91bd7ace8f5",
"permanent_download_url": "http://app.docspring.local/submissions/sub_list_000002/download",
"processed_at": "2020-05-14T02:00:00Z",
"referrer": null,
"source": "api",
"state": "processed",
"template_id": "tpl_000000000000000001",
"test": true,
"truncated_text": {
"first_name": [
"F. Scott Fitzgerald"
]
}
},
{
"actions": [],
"batch_id": null,
"data": {
"first_name": "John C. D. Rom Laserdisk F. Scott Fitzgerald",
"last_name": "Smith",
"phone_number": "+11234567890"
},
"data_requests": [],
"download_url": "https://example.com/submissions/submission.pdf",
"editable": false,
"expired": false,
"expires_at": "2020-10-27T13:00:00Z",
"id": "sub_list_000003",
"json_schema_errors": [],
"metadata": {
"qux": "abc",
"user_id": 42
},
"password": null,
"pdf_hash": "bbc369dd471442006963e3244a1b43610e066165c09770978221f91bd7ace8f5",
"permanent_download_url": "http://app.docspring.local/submissions/sub_list_000003/download",
"processed_at": "2020-05-14T02:00:00Z",
"referrer": null,
"source": "api",
"state": "processed",
"template_id": "tpl_000000000000000001",
"test": true,
"truncated_text": {
"first_name": [
"F. Scott Fitzgerald"
]
}
}
]
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Invalid submission type: 'foo'",
"status": "error"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Invalid API token secret"
}
GET
Look up a submission data request
{{baseUrl}}/data_requests/:data_request_id
QUERY PARAMS
data_request_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/data_requests/:data_request_id");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/data_requests/:data_request_id")require "http/client"
url = "{{baseUrl}}/data_requests/:data_request_id"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/data_requests/:data_request_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/data_requests/:data_request_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/data_requests/:data_request_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/data_requests/:data_request_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/data_requests/:data_request_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/data_requests/:data_request_id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/data_requests/:data_request_id")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/data_requests/:data_request_id")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/data_requests/:data_request_id');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/data_requests/:data_request_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/data_requests/:data_request_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/data_requests/:data_request_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/data_requests/:data_request_id")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/data_requests/:data_request_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/data_requests/:data_request_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/data_requests/:data_request_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/data_requests/:data_request_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/data_requests/:data_request_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/data_requests/:data_request_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/data_requests/:data_request_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/data_requests/:data_request_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/data_requests/:data_request_id');
echo $response->getBody();setUrl('{{baseUrl}}/data_requests/:data_request_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/data_requests/:data_request_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/data_requests/:data_request_id' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/data_requests/:data_request_id' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/data_requests/:data_request_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/data_requests/:data_request_id"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/data_requests/:data_request_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/data_requests/:data_request_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/data_requests/:data_request_id') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/data_requests/:data_request_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/data_requests/:data_request_idhttp GET {{baseUrl}}/data_requests/:data_request_idwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/data_requests/:data_request_idimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/data_requests/:data_request_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"auth_phone_number_hash": "fdcc3985b0698d655137019b1e776171081369f0aad125b8c7f57af2b8225490",
"auth_provider": null,
"auth_second_factor_type": "phone_number",
"auth_session_id_hash": null,
"auth_session_started_at": "2018-10-23T13:00:00Z",
"auth_type": "password",
"auth_user_id_hash": "8ae0e445664ca53407906db8638d8ba07a2383f656383a4427bed1ab645ca29a",
"auth_username_hash": "b7c141423f7030a6a771563ee0731192ea871146653a3d0cf8f8b78ca8f9699b",
"completed_at": null,
"data": {
"last_name": "Smithers"
},
"email": "jdoe@example.com",
"fields": [
"last_name"
],
"id": "drq_000000000000000001",
"ip_address": "1.1.1.1",
"metadata": {
"user_id": 42
},
"name": "John Doe",
"order": 1,
"sort_order": 0,
"state": "pending",
"submission_id": "sub_000000000000000001",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.122 Safari/537.36",
"viewed_at": null
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Invalid API token secret"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Data request not found.",
"status": "error"
}
POST
Merge generated PDFs together
{{baseUrl}}/combined_submissions
BODY json
{
"expires_in": 0,
"metadata": {},
"password": "",
"submission_ids": [],
"test": false
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/combined_submissions");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"submission_ids\": [],\n \"test\": false\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/combined_submissions" {:content-type :json
:form-params {:expires_in 0
:metadata {}
:password ""
:submission_ids []
:test false}})require "http/client"
url = "{{baseUrl}}/combined_submissions"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"submission_ids\": [],\n \"test\": false\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/combined_submissions"),
Content = new StringContent("{\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"submission_ids\": [],\n \"test\": false\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/combined_submissions");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"submission_ids\": [],\n \"test\": false\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/combined_submissions"
payload := strings.NewReader("{\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"submission_ids\": [],\n \"test\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/combined_submissions HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 98
{
"expires_in": 0,
"metadata": {},
"password": "",
"submission_ids": [],
"test": false
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/combined_submissions")
.setHeader("content-type", "application/json")
.setBody("{\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"submission_ids\": [],\n \"test\": false\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/combined_submissions"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"submission_ids\": [],\n \"test\": false\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"submission_ids\": [],\n \"test\": false\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/combined_submissions")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/combined_submissions")
.header("content-type", "application/json")
.body("{\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"submission_ids\": [],\n \"test\": false\n}")
.asString(); const data = JSON.stringify({
expires_in: 0,
metadata: {},
password: '',
submission_ids: [],
test: false
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/combined_submissions');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/combined_submissions',
headers: {'content-type': 'application/json'},
data: {expires_in: 0, metadata: {}, password: '', submission_ids: [], test: false}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/combined_submissions';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"expires_in":0,"metadata":{},"password":"","submission_ids":[],"test":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/combined_submissions',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "expires_in": 0,\n "metadata": {},\n "password": "",\n "submission_ids": [],\n "test": false\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"submission_ids\": [],\n \"test\": false\n}")
val request = Request.Builder()
.url("{{baseUrl}}/combined_submissions")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/combined_submissions',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({expires_in: 0, metadata: {}, password: '', submission_ids: [], test: false}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/combined_submissions',
headers: {'content-type': 'application/json'},
body: {expires_in: 0, metadata: {}, password: '', submission_ids: [], test: false},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/combined_submissions');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
expires_in: 0,
metadata: {},
password: '',
submission_ids: [],
test: false
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/combined_submissions',
headers: {'content-type': 'application/json'},
data: {expires_in: 0, metadata: {}, password: '', submission_ids: [], test: false}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/combined_submissions';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"expires_in":0,"metadata":{},"password":"","submission_ids":[],"test":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"expires_in": @0,
@"metadata": @{ },
@"password": @"",
@"submission_ids": @[ ],
@"test": @NO };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/combined_submissions"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/combined_submissions" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"submission_ids\": [],\n \"test\": false\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/combined_submissions",
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([
'expires_in' => 0,
'metadata' => [
],
'password' => '',
'submission_ids' => [
],
'test' => null
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/combined_submissions', [
'body' => '{
"expires_in": 0,
"metadata": {},
"password": "",
"submission_ids": [],
"test": false
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/combined_submissions');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'expires_in' => 0,
'metadata' => [
],
'password' => '',
'submission_ids' => [
],
'test' => null
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'expires_in' => 0,
'metadata' => [
],
'password' => '',
'submission_ids' => [
],
'test' => null
]));
$request->setRequestUrl('{{baseUrl}}/combined_submissions');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/combined_submissions' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"expires_in": 0,
"metadata": {},
"password": "",
"submission_ids": [],
"test": false
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/combined_submissions' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"expires_in": 0,
"metadata": {},
"password": "",
"submission_ids": [],
"test": false
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"submission_ids\": [],\n \"test\": false\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/combined_submissions", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/combined_submissions"
payload = {
"expires_in": 0,
"metadata": {},
"password": "",
"submission_ids": [],
"test": False
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/combined_submissions"
payload <- "{\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"submission_ids\": [],\n \"test\": false\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/combined_submissions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"submission_ids\": [],\n \"test\": false\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/combined_submissions') do |req|
req.body = "{\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"submission_ids\": [],\n \"test\": false\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/combined_submissions";
let payload = json!({
"expires_in": 0,
"metadata": json!({}),
"password": "",
"submission_ids": (),
"test": false
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/combined_submissions \
--header 'content-type: application/json' \
--data '{
"expires_in": 0,
"metadata": {},
"password": "",
"submission_ids": [],
"test": false
}'echo '{
"expires_in": 0,
"metadata": {},
"password": "",
"submission_ids": [],
"test": false
}' | \
http POST {{baseUrl}}/combined_submissions \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "expires_in": 0,\n "metadata": {},\n "password": "",\n "submission_ids": [],\n "test": false\n}' \
--output-document \
- {{baseUrl}}/combined_submissionsimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"expires_in": 0,
"metadata": [],
"password": "",
"submission_ids": [],
"test": false
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/combined_submissions")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"combined_submission": {
"actions": [],
"download_url": null,
"error_message": null,
"expired": false,
"expires_at": null,
"expires_in": 300,
"id": "com_000000000000000001",
"metadata": {
"bar": "baz",
"foo": 123
},
"password": "p@ssword",
"pdf_hash": null,
"processed_at": null,
"source_pdfs": [],
"state": "pending",
"submission_ids": [
"sub_000000000000000001",
"sub_000000000000000002"
]
},
"status": "success"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "There was a problem with the JSON you submitted: unexpected character at line 1, column 37 in '{ \"submission_ids\": [\"123\", \"345\"], metadata: { \"user_id\": \"@#)(*%$)@(#*%@&%\" }}",
"status": "error"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Unauthorized"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"errors": [
"source_pdfs: Could not find Submission with ID: MISSING_ID"
],
"status": "error"
}
POST
Merge submission PDFs, template PDFs, or custom files
{{baseUrl}}/combined_submissions?v=2
BODY json
{
"delete_custom_files": false,
"expires_in": 0,
"metadata": {},
"password": "",
"source_pdfs": [],
"test": false
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/combined_submissions?v=2");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"delete_custom_files\": false,\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"source_pdfs\": [],\n \"test\": false\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/combined_submissions" {:query-params {:v "2"}
:content-type :json
:form-params {:delete_custom_files false
:expires_in 0
:metadata {}
:password ""
:source_pdfs []
:test false}})require "http/client"
url = "{{baseUrl}}/combined_submissions?v=2"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"delete_custom_files\": false,\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"source_pdfs\": [],\n \"test\": false\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/combined_submissions?v=2"),
Content = new StringContent("{\n \"delete_custom_files\": false,\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"source_pdfs\": [],\n \"test\": false\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/combined_submissions?v=2");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"delete_custom_files\": false,\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"source_pdfs\": [],\n \"test\": false\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/combined_submissions?v=2"
payload := strings.NewReader("{\n \"delete_custom_files\": false,\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"source_pdfs\": [],\n \"test\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/combined_submissions?v=2 HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 127
{
"delete_custom_files": false,
"expires_in": 0,
"metadata": {},
"password": "",
"source_pdfs": [],
"test": false
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/combined_submissions?v=2")
.setHeader("content-type", "application/json")
.setBody("{\n \"delete_custom_files\": false,\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"source_pdfs\": [],\n \"test\": false\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/combined_submissions?v=2"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"delete_custom_files\": false,\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"source_pdfs\": [],\n \"test\": false\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"delete_custom_files\": false,\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"source_pdfs\": [],\n \"test\": false\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/combined_submissions?v=2")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/combined_submissions?v=2")
.header("content-type", "application/json")
.body("{\n \"delete_custom_files\": false,\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"source_pdfs\": [],\n \"test\": false\n}")
.asString(); const data = JSON.stringify({
delete_custom_files: false,
expires_in: 0,
metadata: {},
password: '',
source_pdfs: [],
test: false
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/combined_submissions?v=2');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/combined_submissions',
params: {v: '2'},
headers: {'content-type': 'application/json'},
data: {
delete_custom_files: false,
expires_in: 0,
metadata: {},
password: '',
source_pdfs: [],
test: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/combined_submissions?v=2';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"delete_custom_files":false,"expires_in":0,"metadata":{},"password":"","source_pdfs":[],"test":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/combined_submissions?v=2',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "delete_custom_files": false,\n "expires_in": 0,\n "metadata": {},\n "password": "",\n "source_pdfs": [],\n "test": false\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"delete_custom_files\": false,\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"source_pdfs\": [],\n \"test\": false\n}")
val request = Request.Builder()
.url("{{baseUrl}}/combined_submissions?v=2")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/combined_submissions?v=2',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
delete_custom_files: false,
expires_in: 0,
metadata: {},
password: '',
source_pdfs: [],
test: false
}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/combined_submissions',
qs: {v: '2'},
headers: {'content-type': 'application/json'},
body: {
delete_custom_files: false,
expires_in: 0,
metadata: {},
password: '',
source_pdfs: [],
test: false
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/combined_submissions');
req.query({
v: '2'
});
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
delete_custom_files: false,
expires_in: 0,
metadata: {},
password: '',
source_pdfs: [],
test: false
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/combined_submissions',
params: {v: '2'},
headers: {'content-type': 'application/json'},
data: {
delete_custom_files: false,
expires_in: 0,
metadata: {},
password: '',
source_pdfs: [],
test: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/combined_submissions?v=2';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"delete_custom_files":false,"expires_in":0,"metadata":{},"password":"","source_pdfs":[],"test":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"delete_custom_files": @NO,
@"expires_in": @0,
@"metadata": @{ },
@"password": @"",
@"source_pdfs": @[ ],
@"test": @NO };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/combined_submissions?v=2"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/combined_submissions?v=2" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"delete_custom_files\": false,\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"source_pdfs\": [],\n \"test\": false\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/combined_submissions?v=2",
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([
'delete_custom_files' => null,
'expires_in' => 0,
'metadata' => [
],
'password' => '',
'source_pdfs' => [
],
'test' => null
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/combined_submissions?v=2', [
'body' => '{
"delete_custom_files": false,
"expires_in": 0,
"metadata": {},
"password": "",
"source_pdfs": [],
"test": false
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/combined_submissions');
$request->setMethod(HTTP_METH_POST);
$request->setQueryData([
'v' => '2'
]);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'delete_custom_files' => null,
'expires_in' => 0,
'metadata' => [
],
'password' => '',
'source_pdfs' => [
],
'test' => null
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'delete_custom_files' => null,
'expires_in' => 0,
'metadata' => [
],
'password' => '',
'source_pdfs' => [
],
'test' => null
]));
$request->setRequestUrl('{{baseUrl}}/combined_submissions');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setQuery(new http\QueryString([
'v' => '2'
]));
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/combined_submissions?v=2' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"delete_custom_files": false,
"expires_in": 0,
"metadata": {},
"password": "",
"source_pdfs": [],
"test": false
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/combined_submissions?v=2' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"delete_custom_files": false,
"expires_in": 0,
"metadata": {},
"password": "",
"source_pdfs": [],
"test": false
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"delete_custom_files\": false,\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"source_pdfs\": [],\n \"test\": false\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/combined_submissions?v=2", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/combined_submissions"
querystring = {"v":"2"}
payload = {
"delete_custom_files": False,
"expires_in": 0,
"metadata": {},
"password": "",
"source_pdfs": [],
"test": False
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/combined_submissions"
queryString <- list(v = "2")
payload <- "{\n \"delete_custom_files\": false,\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"source_pdfs\": [],\n \"test\": false\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/combined_submissions?v=2")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"delete_custom_files\": false,\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"source_pdfs\": [],\n \"test\": false\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/combined_submissions') do |req|
req.params['v'] = '2'
req.body = "{\n \"delete_custom_files\": false,\n \"expires_in\": 0,\n \"metadata\": {},\n \"password\": \"\",\n \"source_pdfs\": [],\n \"test\": false\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/combined_submissions";
let querystring = [
("v", "2"),
];
let payload = json!({
"delete_custom_files": false,
"expires_in": 0,
"metadata": json!({}),
"password": "",
"source_pdfs": (),
"test": false
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.query(&querystring)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url '{{baseUrl}}/combined_submissions?v=2' \
--header 'content-type: application/json' \
--data '{
"delete_custom_files": false,
"expires_in": 0,
"metadata": {},
"password": "",
"source_pdfs": [],
"test": false
}'echo '{
"delete_custom_files": false,
"expires_in": 0,
"metadata": {},
"password": "",
"source_pdfs": [],
"test": false
}' | \
http POST '{{baseUrl}}/combined_submissions?v=2' \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "delete_custom_files": false,\n "expires_in": 0,\n "metadata": {},\n "password": "",\n "source_pdfs": [],\n "test": false\n}' \
--output-document \
- '{{baseUrl}}/combined_submissions?v=2'import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"delete_custom_files": false,
"expires_in": 0,
"metadata": [],
"password": "",
"source_pdfs": [],
"test": false
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/combined_submissions?v=2")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"combined_submission": {
"actions": [
{
"action_category": "file_upload",
"action_type": "aws_s3_upload",
"id": "csa_000000000000000002",
"integration_id": "aci_000000000000000001",
"result_data": {
"s3_bucket": "docspring-custom-s3-test",
"s3_key": "acc_1234/2018/combined_submissions/20181005090010-com_1234.pdf",
"s3_region": "us-east-1",
"s3_url": "https://docspring-custom-s3-test.s3.amazonaws.com/acc_1234/2018/combined_submissions/20181005090010-com_1234.pdf"
},
"state": "processed"
}
],
"download_url": null,
"error_message": null,
"expired": false,
"expires_at": null,
"expires_in": 300,
"id": "com_000000000000000002",
"metadata": {
"bar": "baz",
"foo": 123
},
"password": null,
"pdf_hash": null,
"processed_at": null,
"source_pdfs": [
{
"id": "sub_000000000000000001",
"type": "submission"
},
{
"id": "tpl_000000000000000001",
"type": "template"
},
{
"id": "sub_000000000000000002",
"type": "submission"
},
{
"id": "cfi_0000000000000000000000001",
"type": "custom_file"
},
{
"id": "com_000000000000000001",
"type": "combined_submission"
},
{
"type": "url",
"url": "http://example.com/test-pdf.pdf"
}
],
"state": "pending",
"submission_ids": [
"sub_000000000000000001",
"sub_000000000000000002"
]
},
"status": "success"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "There was a problem with the JSON you submitted: unexpected character at line 1, column 34 in '{ \"source_pdfs\": [\"123\", \"345\"], metadata: { \"user_id\": \"@#*&%)(@*#%&(@#!\" }}",
"status": "error"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Unauthorized"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"errors": [
"source_pdfs: Could not find Submission with ID: MISSING_SUBMISSION_ID",
"source_pdfs: Template document is not processed: tpl_000000000000000001 (state: pending)",
"source_pdfs: Could not find Template with ID: MISSING_TEMPLATE_ID",
"source_pdfs: Could not find Custom File with ID: MISSING_CUSTOM_FILE_ID",
"source_pdfs: Could not find Combined Submission with ID: MISSING_COMBINED_SUBMISSION_ID"
],
"status": "error"
}
POST
Move Template to folder
{{baseUrl}}/templates/:template_id/move
QUERY PARAMS
template_id
BODY json
{
"parent_folder_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/templates/:template_id/move");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"parent_folder_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/templates/:template_id/move" {:content-type :json
:form-params {:parent_folder_id ""}})require "http/client"
url = "{{baseUrl}}/templates/:template_id/move"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"parent_folder_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/templates/:template_id/move"),
Content = new StringContent("{\n \"parent_folder_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/templates/:template_id/move");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"parent_folder_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/templates/:template_id/move"
payload := strings.NewReader("{\n \"parent_folder_id\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/templates/:template_id/move HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 28
{
"parent_folder_id": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/templates/:template_id/move")
.setHeader("content-type", "application/json")
.setBody("{\n \"parent_folder_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/templates/:template_id/move"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"parent_folder_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"parent_folder_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/templates/:template_id/move")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/templates/:template_id/move")
.header("content-type", "application/json")
.body("{\n \"parent_folder_id\": \"\"\n}")
.asString(); const data = JSON.stringify({
parent_folder_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/templates/:template_id/move');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/templates/:template_id/move',
headers: {'content-type': 'application/json'},
data: {parent_folder_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/templates/:template_id/move';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"parent_folder_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/templates/:template_id/move',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "parent_folder_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"parent_folder_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/templates/:template_id/move")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/templates/:template_id/move',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({parent_folder_id: ''}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/templates/:template_id/move',
headers: {'content-type': 'application/json'},
body: {parent_folder_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/templates/:template_id/move');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
parent_folder_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/templates/:template_id/move',
headers: {'content-type': 'application/json'},
data: {parent_folder_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/templates/:template_id/move';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"parent_folder_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"parent_folder_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/templates/:template_id/move"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/templates/:template_id/move" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"parent_folder_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/templates/:template_id/move",
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([
'parent_folder_id' => ''
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/templates/:template_id/move', [
'body' => '{
"parent_folder_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/templates/:template_id/move');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'parent_folder_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'parent_folder_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/templates/:template_id/move');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/templates/:template_id/move' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"parent_folder_id": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/templates/:template_id/move' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"parent_folder_id": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"parent_folder_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/templates/:template_id/move", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/templates/:template_id/move"
payload = { "parent_folder_id": "" }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/templates/:template_id/move"
payload <- "{\n \"parent_folder_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/templates/:template_id/move")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"parent_folder_id\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/templates/:template_id/move') do |req|
req.body = "{\n \"parent_folder_id\": \"\"\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/templates/:template_id/move";
let payload = json!({"parent_folder_id": ""});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/templates/:template_id/move \
--header 'content-type: application/json' \
--data '{
"parent_folder_id": ""
}'echo '{
"parent_folder_id": ""
}' | \
http POST {{baseUrl}}/templates/:template_id/move \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "parent_folder_id": ""\n}' \
--output-document \
- {{baseUrl}}/templates/:template_id/moveimport Foundation
let headers = ["content-type": "application/json"]
let parameters = ["parent_folder_id": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/templates/:template_id/move")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"allow_additional_properties": false,
"description": null,
"document_filename": "blank_pdf.pdf",
"document_processed": true,
"document_state": "processed",
"document_url": "/uploads/test/store/acc_000000000000000001/templates/tpl_000000000000000001/document/original-0000000000.pdf",
"editable_submissions": false,
"expiration_interval": "days",
"expire_after": 7,
"expire_submissions": true,
"id": "tpl_000000000000000001",
"locked": false,
"name": "Template 1",
"page_count": 1,
"page_dimensions": [
[
612,
792
]
],
"parent_folder_id": "fld_000000000000000001",
"path": "/Folder",
"permanent_document_url": "http://app.docspring.local/templates/tpl_000000000000000001/original_pdf?token=123456789abcdef",
"public_submissions": false,
"public_web_form": false,
"redirect_url": null,
"slack_webhook_url": null,
"template_type": "pdf",
"webhook_url": null
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Could not find parent folder MISSING_ID",
"status": "error"
}
POST
Move a folder
{{baseUrl}}/folders/:folder_id/move
QUERY PARAMS
folder_id
BODY json
{
"parent_folder_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id/move");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"parent_folder_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/folders/:folder_id/move" {:content-type :json
:form-params {:parent_folder_id ""}})require "http/client"
url = "{{baseUrl}}/folders/:folder_id/move"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"parent_folder_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/folders/:folder_id/move"),
Content = new StringContent("{\n \"parent_folder_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/folders/:folder_id/move");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"parent_folder_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id/move"
payload := strings.NewReader("{\n \"parent_folder_id\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/folders/:folder_id/move HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 28
{
"parent_folder_id": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/folders/:folder_id/move")
.setHeader("content-type", "application/json")
.setBody("{\n \"parent_folder_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id/move"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"parent_folder_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"parent_folder_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/move")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/folders/:folder_id/move")
.header("content-type", "application/json")
.body("{\n \"parent_folder_id\": \"\"\n}")
.asString(); const data = JSON.stringify({
parent_folder_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/folders/:folder_id/move');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/folders/:folder_id/move',
headers: {'content-type': 'application/json'},
data: {parent_folder_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/folders/:folder_id/move';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"parent_folder_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/folders/:folder_id/move',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "parent_folder_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"parent_folder_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/move")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/folders/:folder_id/move',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({parent_folder_id: ''}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/folders/:folder_id/move',
headers: {'content-type': 'application/json'},
body: {parent_folder_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/folders/:folder_id/move');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
parent_folder_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/folders/:folder_id/move',
headers: {'content-type': 'application/json'},
data: {parent_folder_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id/move';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"parent_folder_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"parent_folder_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id/move"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/folders/:folder_id/move" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"parent_folder_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/folders/:folder_id/move",
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([
'parent_folder_id' => ''
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/folders/:folder_id/move', [
'body' => '{
"parent_folder_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/folders/:folder_id/move');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'parent_folder_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'parent_folder_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/folders/:folder_id/move');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/folders/:folder_id/move' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"parent_folder_id": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id/move' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"parent_folder_id": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"parent_folder_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/folders/:folder_id/move", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/folders/:folder_id/move"
payload = { "parent_folder_id": "" }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/folders/:folder_id/move"
payload <- "{\n \"parent_folder_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/:folder_id/move")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"parent_folder_id\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/folders/:folder_id/move') do |req|
req.body = "{\n \"parent_folder_id\": \"\"\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id/move";
let payload = json!({"parent_folder_id": ""});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/folders/:folder_id/move \
--header 'content-type: application/json' \
--data '{
"parent_folder_id": ""
}'echo '{
"parent_folder_id": ""
}' | \
http POST {{baseUrl}}/folders/:folder_id/move \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "parent_folder_id": ""\n}' \
--output-document \
- {{baseUrl}}/folders/:folder_id/moveimport Foundation
let headers = ["content-type": "application/json"]
let parameters = ["parent_folder_id": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id/move")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"id": "fld_000000000000000001",
"name": "Folder 1",
"parent_folder_id": "fld_000000000000000002",
"path": "/Folder 2"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Unauthorized"
}
POST
Rename a folder
{{baseUrl}}/folders/:folder_id/rename
QUERY PARAMS
folder_id
BODY json
{
"name": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/folders/:folder_id/rename");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"name\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/folders/:folder_id/rename" {:content-type :json
:form-params {:name ""}})require "http/client"
url = "{{baseUrl}}/folders/:folder_id/rename"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"name\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/folders/:folder_id/rename"),
Content = new StringContent("{\n \"name\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/folders/:folder_id/rename");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"name\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/folders/:folder_id/rename"
payload := strings.NewReader("{\n \"name\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/folders/:folder_id/rename HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 16
{
"name": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/folders/:folder_id/rename")
.setHeader("content-type", "application/json")
.setBody("{\n \"name\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/folders/:folder_id/rename"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"name\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"name\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/rename")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/folders/:folder_id/rename")
.header("content-type", "application/json")
.body("{\n \"name\": \"\"\n}")
.asString(); const data = JSON.stringify({
name: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/folders/:folder_id/rename');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/folders/:folder_id/rename',
headers: {'content-type': 'application/json'},
data: {name: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/folders/:folder_id/rename';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"name":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/folders/:folder_id/rename',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "name": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"name\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/folders/:folder_id/rename")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/folders/:folder_id/rename',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({name: ''}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/folders/:folder_id/rename',
headers: {'content-type': 'application/json'},
body: {name: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/folders/:folder_id/rename');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
name: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/folders/:folder_id/rename',
headers: {'content-type': 'application/json'},
data: {name: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/folders/:folder_id/rename';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"name":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"name": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/folders/:folder_id/rename"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/folders/:folder_id/rename" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"name\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/folders/:folder_id/rename",
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' => ''
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/folders/:folder_id/rename', [
'body' => '{
"name": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/folders/:folder_id/rename');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'name' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'name' => ''
]));
$request->setRequestUrl('{{baseUrl}}/folders/:folder_id/rename');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/folders/:folder_id/rename' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"name": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/folders/:folder_id/rename' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"name": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"name\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/folders/:folder_id/rename", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/folders/:folder_id/rename"
payload = { "name": "" }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/folders/:folder_id/rename"
payload <- "{\n \"name\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/folders/:folder_id/rename")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"name\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/folders/:folder_id/rename') do |req|
req.body = "{\n \"name\": \"\"\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/folders/:folder_id/rename";
let payload = json!({"name": ""});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/folders/:folder_id/rename \
--header 'content-type: application/json' \
--data '{
"name": ""
}'echo '{
"name": ""
}' | \
http POST {{baseUrl}}/folders/:folder_id/rename \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "name": ""\n}' \
--output-document \
- {{baseUrl}}/folders/:folder_id/renameimport Foundation
let headers = ["content-type": "application/json"]
let parameters = ["name": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/folders/:folder_id/rename")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"id": "fld_000000000000000001",
"name": "Folder 3",
"parent_folder_id": null,
"path": "/"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Unauthorized"
}
GET
Test Authentication
{{baseUrl}}/authentication
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/authentication");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/authentication")require "http/client"
url = "{{baseUrl}}/authentication"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/authentication"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/authentication");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/authentication"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/authentication HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/authentication")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/authentication"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/authentication")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/authentication")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/authentication');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/authentication'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/authentication';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/authentication',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/authentication")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/authentication',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/authentication'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/authentication');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/authentication'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/authentication';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/authentication"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/authentication" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/authentication",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/authentication');
echo $response->getBody();setUrl('{{baseUrl}}/authentication');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/authentication');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/authentication' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/authentication' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/authentication")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/authentication"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/authentication"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/authentication")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/authentication') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/authentication";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/authenticationhttp GET {{baseUrl}}/authenticationwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/authenticationimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/authentication")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"status": "success"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Unauthorized"
}
PUT
Update a Template
{{baseUrl}}/templates/:template_id
QUERY PARAMS
template_id
BODY json
{
"template": {
"allow_additional_properties": false,
"description": "",
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"webhook_url": ""
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/templates/:template_id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"webhook_url\": \"\"\n }\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/templates/:template_id" {:content-type :json
:form-params {:template {:allow_additional_properties false
:description ""
:editable_submissions false
:expiration_interval ""
:expire_after ""
:expire_submissions false
:footer_html ""
:header_html ""
:html ""
:name ""
:public_submissions false
:public_web_form false
:redirect_url ""
:scss ""
:slack_webhook_url ""
:webhook_url ""}}})require "http/client"
url = "{{baseUrl}}/templates/:template_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"webhook_url\": \"\"\n }\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/templates/:template_id"),
Content = new StringContent("{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"webhook_url\": \"\"\n }\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/templates/:template_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"webhook_url\": \"\"\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/templates/:template_id"
payload := strings.NewReader("{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"webhook_url\": \"\"\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}PUT /baseUrl/templates/:template_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 443
{
"template": {
"allow_additional_properties": false,
"description": "",
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"webhook_url": ""
}
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/templates/:template_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"webhook_url\": \"\"\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/templates/:template_id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"webhook_url\": \"\"\n }\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"webhook_url\": \"\"\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/templates/:template_id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.put("{{baseUrl}}/templates/:template_id")
.header("content-type", "application/json")
.body("{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"webhook_url\": \"\"\n }\n}")
.asString(); const data = JSON.stringify({
template: {
allow_additional_properties: false,
description: '',
editable_submissions: false,
expiration_interval: '',
expire_after: '',
expire_submissions: false,
footer_html: '',
header_html: '',
html: '',
name: '',
public_submissions: false,
public_web_form: false,
redirect_url: '',
scss: '',
slack_webhook_url: '',
webhook_url: ''
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/templates/:template_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/templates/:template_id',
headers: {'content-type': 'application/json'},
data: {
template: {
allow_additional_properties: false,
description: '',
editable_submissions: false,
expiration_interval: '',
expire_after: '',
expire_submissions: false,
footer_html: '',
header_html: '',
html: '',
name: '',
public_submissions: false,
public_web_form: false,
redirect_url: '',
scss: '',
slack_webhook_url: '',
webhook_url: ''
}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/templates/:template_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"template":{"allow_additional_properties":false,"description":"","editable_submissions":false,"expiration_interval":"","expire_after":"","expire_submissions":false,"footer_html":"","header_html":"","html":"","name":"","public_submissions":false,"public_web_form":false,"redirect_url":"","scss":"","slack_webhook_url":"","webhook_url":""}}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/templates/:template_id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "template": {\n "allow_additional_properties": false,\n "description": "",\n "editable_submissions": false,\n "expiration_interval": "",\n "expire_after": "",\n "expire_submissions": false,\n "footer_html": "",\n "header_html": "",\n "html": "",\n "name": "",\n "public_submissions": false,\n "public_web_form": false,\n "redirect_url": "",\n "scss": "",\n "slack_webhook_url": "",\n "webhook_url": ""\n }\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"webhook_url\": \"\"\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/templates/:template_id")
.put(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/templates/:template_id',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
template: {
allow_additional_properties: false,
description: '',
editable_submissions: false,
expiration_interval: '',
expire_after: '',
expire_submissions: false,
footer_html: '',
header_html: '',
html: '',
name: '',
public_submissions: false,
public_web_form: false,
redirect_url: '',
scss: '',
slack_webhook_url: '',
webhook_url: ''
}
}));
req.end();const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/templates/:template_id',
headers: {'content-type': 'application/json'},
body: {
template: {
allow_additional_properties: false,
description: '',
editable_submissions: false,
expiration_interval: '',
expire_after: '',
expire_submissions: false,
footer_html: '',
header_html: '',
html: '',
name: '',
public_submissions: false,
public_web_form: false,
redirect_url: '',
scss: '',
slack_webhook_url: '',
webhook_url: ''
}
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/templates/:template_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
template: {
allow_additional_properties: false,
description: '',
editable_submissions: false,
expiration_interval: '',
expire_after: '',
expire_submissions: false,
footer_html: '',
header_html: '',
html: '',
name: '',
public_submissions: false,
public_web_form: false,
redirect_url: '',
scss: '',
slack_webhook_url: '',
webhook_url: ''
}
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'PUT',
url: '{{baseUrl}}/templates/:template_id',
headers: {'content-type': 'application/json'},
data: {
template: {
allow_additional_properties: false,
description: '',
editable_submissions: false,
expiration_interval: '',
expire_after: '',
expire_submissions: false,
footer_html: '',
header_html: '',
html: '',
name: '',
public_submissions: false,
public_web_form: false,
redirect_url: '',
scss: '',
slack_webhook_url: '',
webhook_url: ''
}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/templates/:template_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"template":{"allow_additional_properties":false,"description":"","editable_submissions":false,"expiration_interval":"","expire_after":"","expire_submissions":false,"footer_html":"","header_html":"","html":"","name":"","public_submissions":false,"public_web_form":false,"redirect_url":"","scss":"","slack_webhook_url":"","webhook_url":""}}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"template": @{ @"allow_additional_properties": @NO, @"description": @"", @"editable_submissions": @NO, @"expiration_interval": @"", @"expire_after": @"", @"expire_submissions": @NO, @"footer_html": @"", @"header_html": @"", @"html": @"", @"name": @"", @"public_submissions": @NO, @"public_web_form": @NO, @"redirect_url": @"", @"scss": @"", @"slack_webhook_url": @"", @"webhook_url": @"" } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/templates/:template_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/templates/:template_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"webhook_url\": \"\"\n }\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/templates/:template_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 => json_encode([
'template' => [
'allow_additional_properties' => null,
'description' => '',
'editable_submissions' => null,
'expiration_interval' => '',
'expire_after' => '',
'expire_submissions' => null,
'footer_html' => '',
'header_html' => '',
'html' => '',
'name' => '',
'public_submissions' => null,
'public_web_form' => null,
'redirect_url' => '',
'scss' => '',
'slack_webhook_url' => '',
'webhook_url' => ''
]
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('PUT', '{{baseUrl}}/templates/:template_id', [
'body' => '{
"template": {
"allow_additional_properties": false,
"description": "",
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"webhook_url": ""
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/templates/:template_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'template' => [
'allow_additional_properties' => null,
'description' => '',
'editable_submissions' => null,
'expiration_interval' => '',
'expire_after' => '',
'expire_submissions' => null,
'footer_html' => '',
'header_html' => '',
'html' => '',
'name' => '',
'public_submissions' => null,
'public_web_form' => null,
'redirect_url' => '',
'scss' => '',
'slack_webhook_url' => '',
'webhook_url' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'template' => [
'allow_additional_properties' => null,
'description' => '',
'editable_submissions' => null,
'expiration_interval' => '',
'expire_after' => '',
'expire_submissions' => null,
'footer_html' => '',
'header_html' => '',
'html' => '',
'name' => '',
'public_submissions' => null,
'public_web_form' => null,
'redirect_url' => '',
'scss' => '',
'slack_webhook_url' => '',
'webhook_url' => ''
]
]));
$request->setRequestUrl('{{baseUrl}}/templates/:template_id');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/templates/:template_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"template": {
"allow_additional_properties": false,
"description": "",
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"webhook_url": ""
}
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/templates/:template_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"template": {
"allow_additional_properties": false,
"description": "",
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"webhook_url": ""
}
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"webhook_url\": \"\"\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/templates/:template_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/templates/:template_id"
payload = { "template": {
"allow_additional_properties": False,
"description": "",
"editable_submissions": False,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": False,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": False,
"public_web_form": False,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"webhook_url": ""
} }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/templates/:template_id"
payload <- "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"webhook_url\": \"\"\n }\n}"
encode <- "json"
response <- VERB("PUT", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/templates/:template_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"webhook_url\": \"\"\n }\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/templates/:template_id') do |req|
req.body = "{\n \"template\": {\n \"allow_additional_properties\": false,\n \"description\": \"\",\n \"editable_submissions\": false,\n \"expiration_interval\": \"\",\n \"expire_after\": \"\",\n \"expire_submissions\": false,\n \"footer_html\": \"\",\n \"header_html\": \"\",\n \"html\": \"\",\n \"name\": \"\",\n \"public_submissions\": false,\n \"public_web_form\": false,\n \"redirect_url\": \"\",\n \"scss\": \"\",\n \"slack_webhook_url\": \"\",\n \"webhook_url\": \"\"\n }\n}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/templates/:template_id";
let payload = json!({"template": json!({
"allow_additional_properties": false,
"description": "",
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"webhook_url": ""
})});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/templates/:template_id \
--header 'content-type: application/json' \
--data '{
"template": {
"allow_additional_properties": false,
"description": "",
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"webhook_url": ""
}
}'echo '{
"template": {
"allow_additional_properties": false,
"description": "",
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"webhook_url": ""
}
}' | \
http PUT {{baseUrl}}/templates/:template_id \
content-type:application/jsonwget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "template": {\n "allow_additional_properties": false,\n "description": "",\n "editable_submissions": false,\n "expiration_interval": "",\n "expire_after": "",\n "expire_submissions": false,\n "footer_html": "",\n "header_html": "",\n "html": "",\n "name": "",\n "public_submissions": false,\n "public_web_form": false,\n "redirect_url": "",\n "scss": "",\n "slack_webhook_url": "",\n "webhook_url": ""\n }\n}' \
--output-document \
- {{baseUrl}}/templates/:template_idimport Foundation
let headers = ["content-type": "application/json"]
let parameters = ["template": [
"allow_additional_properties": false,
"description": "",
"editable_submissions": false,
"expiration_interval": "",
"expire_after": "",
"expire_submissions": false,
"footer_html": "",
"header_html": "",
"html": "",
"name": "",
"public_submissions": false,
"public_web_form": false,
"redirect_url": "",
"scss": "",
"slack_webhook_url": "",
"webhook_url": ""
]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/templates/:template_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"status": "success"
}
PUT
Update a submission data request
{{baseUrl}}/data_requests/:data_request_id
QUERY PARAMS
data_request_id
BODY json
{
"auth_phone_number_hash": "",
"auth_provider": "",
"auth_second_factor_type": "",
"auth_session_id_hash": "",
"auth_session_started_at": "",
"auth_type": "",
"auth_user_id_hash": "",
"auth_username_hash": "",
"email": "",
"fields": [],
"metadata": {},
"name": "",
"order": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/data_requests/:data_request_id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/data_requests/:data_request_id" {:content-type :json
:form-params {:auth_phone_number_hash ""
:auth_provider ""
:auth_second_factor_type ""
:auth_session_id_hash ""
:auth_session_started_at ""
:auth_type ""
:auth_user_id_hash ""
:auth_username_hash ""
:email ""
:fields []
:metadata {}
:name ""
:order 0}})require "http/client"
url = "{{baseUrl}}/data_requests/:data_request_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/data_requests/:data_request_id"),
Content = new StringContent("{\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/data_requests/:data_request_id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/data_requests/:data_request_id"
payload := strings.NewReader("{\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}PUT /baseUrl/data_requests/:data_request_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 304
{
"auth_phone_number_hash": "",
"auth_provider": "",
"auth_second_factor_type": "",
"auth_session_id_hash": "",
"auth_session_started_at": "",
"auth_type": "",
"auth_user_id_hash": "",
"auth_username_hash": "",
"email": "",
"fields": [],
"metadata": {},
"name": "",
"order": 0
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/data_requests/:data_request_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/data_requests/:data_request_id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/data_requests/:data_request_id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.put("{{baseUrl}}/data_requests/:data_request_id")
.header("content-type", "application/json")
.body("{\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n}")
.asString(); const data = JSON.stringify({
auth_phone_number_hash: '',
auth_provider: '',
auth_second_factor_type: '',
auth_session_id_hash: '',
auth_session_started_at: '',
auth_type: '',
auth_user_id_hash: '',
auth_username_hash: '',
email: '',
fields: [],
metadata: {},
name: '',
order: 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/data_requests/:data_request_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/data_requests/:data_request_id',
headers: {'content-type': 'application/json'},
data: {
auth_phone_number_hash: '',
auth_provider: '',
auth_second_factor_type: '',
auth_session_id_hash: '',
auth_session_started_at: '',
auth_type: '',
auth_user_id_hash: '',
auth_username_hash: '',
email: '',
fields: [],
metadata: {},
name: '',
order: 0
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/data_requests/:data_request_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"auth_phone_number_hash":"","auth_provider":"","auth_second_factor_type":"","auth_session_id_hash":"","auth_session_started_at":"","auth_type":"","auth_user_id_hash":"","auth_username_hash":"","email":"","fields":[],"metadata":{},"name":"","order":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/data_requests/:data_request_id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "auth_phone_number_hash": "",\n "auth_provider": "",\n "auth_second_factor_type": "",\n "auth_session_id_hash": "",\n "auth_session_started_at": "",\n "auth_type": "",\n "auth_user_id_hash": "",\n "auth_username_hash": "",\n "email": "",\n "fields": [],\n "metadata": {},\n "name": "",\n "order": 0\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n}")
val request = Request.Builder()
.url("{{baseUrl}}/data_requests/:data_request_id")
.put(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/data_requests/:data_request_id',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
auth_phone_number_hash: '',
auth_provider: '',
auth_second_factor_type: '',
auth_session_id_hash: '',
auth_session_started_at: '',
auth_type: '',
auth_user_id_hash: '',
auth_username_hash: '',
email: '',
fields: [],
metadata: {},
name: '',
order: 0
}));
req.end();const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/data_requests/:data_request_id',
headers: {'content-type': 'application/json'},
body: {
auth_phone_number_hash: '',
auth_provider: '',
auth_second_factor_type: '',
auth_session_id_hash: '',
auth_session_started_at: '',
auth_type: '',
auth_user_id_hash: '',
auth_username_hash: '',
email: '',
fields: [],
metadata: {},
name: '',
order: 0
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/data_requests/:data_request_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
auth_phone_number_hash: '',
auth_provider: '',
auth_second_factor_type: '',
auth_session_id_hash: '',
auth_session_started_at: '',
auth_type: '',
auth_user_id_hash: '',
auth_username_hash: '',
email: '',
fields: [],
metadata: {},
name: '',
order: 0
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'PUT',
url: '{{baseUrl}}/data_requests/:data_request_id',
headers: {'content-type': 'application/json'},
data: {
auth_phone_number_hash: '',
auth_provider: '',
auth_second_factor_type: '',
auth_session_id_hash: '',
auth_session_started_at: '',
auth_type: '',
auth_user_id_hash: '',
auth_username_hash: '',
email: '',
fields: [],
metadata: {},
name: '',
order: 0
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/data_requests/:data_request_id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"auth_phone_number_hash":"","auth_provider":"","auth_second_factor_type":"","auth_session_id_hash":"","auth_session_started_at":"","auth_type":"","auth_user_id_hash":"","auth_username_hash":"","email":"","fields":[],"metadata":{},"name":"","order":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"auth_phone_number_hash": @"",
@"auth_provider": @"",
@"auth_second_factor_type": @"",
@"auth_session_id_hash": @"",
@"auth_session_started_at": @"",
@"auth_type": @"",
@"auth_user_id_hash": @"",
@"auth_username_hash": @"",
@"email": @"",
@"fields": @[ ],
@"metadata": @{ },
@"name": @"",
@"order": @0 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/data_requests/:data_request_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/data_requests/:data_request_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/data_requests/:data_request_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 => json_encode([
'auth_phone_number_hash' => '',
'auth_provider' => '',
'auth_second_factor_type' => '',
'auth_session_id_hash' => '',
'auth_session_started_at' => '',
'auth_type' => '',
'auth_user_id_hash' => '',
'auth_username_hash' => '',
'email' => '',
'fields' => [
],
'metadata' => [
],
'name' => '',
'order' => 0
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('PUT', '{{baseUrl}}/data_requests/:data_request_id', [
'body' => '{
"auth_phone_number_hash": "",
"auth_provider": "",
"auth_second_factor_type": "",
"auth_session_id_hash": "",
"auth_session_started_at": "",
"auth_type": "",
"auth_user_id_hash": "",
"auth_username_hash": "",
"email": "",
"fields": [],
"metadata": {},
"name": "",
"order": 0
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/data_requests/:data_request_id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'auth_phone_number_hash' => '',
'auth_provider' => '',
'auth_second_factor_type' => '',
'auth_session_id_hash' => '',
'auth_session_started_at' => '',
'auth_type' => '',
'auth_user_id_hash' => '',
'auth_username_hash' => '',
'email' => '',
'fields' => [
],
'metadata' => [
],
'name' => '',
'order' => 0
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'auth_phone_number_hash' => '',
'auth_provider' => '',
'auth_second_factor_type' => '',
'auth_session_id_hash' => '',
'auth_session_started_at' => '',
'auth_type' => '',
'auth_user_id_hash' => '',
'auth_username_hash' => '',
'email' => '',
'fields' => [
],
'metadata' => [
],
'name' => '',
'order' => 0
]));
$request->setRequestUrl('{{baseUrl}}/data_requests/:data_request_id');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/data_requests/:data_request_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"auth_phone_number_hash": "",
"auth_provider": "",
"auth_second_factor_type": "",
"auth_session_id_hash": "",
"auth_session_started_at": "",
"auth_type": "",
"auth_user_id_hash": "",
"auth_username_hash": "",
"email": "",
"fields": [],
"metadata": {},
"name": "",
"order": 0
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/data_requests/:data_request_id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"auth_phone_number_hash": "",
"auth_provider": "",
"auth_second_factor_type": "",
"auth_session_id_hash": "",
"auth_session_started_at": "",
"auth_type": "",
"auth_user_id_hash": "",
"auth_username_hash": "",
"email": "",
"fields": [],
"metadata": {},
"name": "",
"order": 0
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/data_requests/:data_request_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/data_requests/:data_request_id"
payload = {
"auth_phone_number_hash": "",
"auth_provider": "",
"auth_second_factor_type": "",
"auth_session_id_hash": "",
"auth_session_started_at": "",
"auth_type": "",
"auth_user_id_hash": "",
"auth_username_hash": "",
"email": "",
"fields": [],
"metadata": {},
"name": "",
"order": 0
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/data_requests/:data_request_id"
payload <- "{\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n}"
encode <- "json"
response <- VERB("PUT", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/data_requests/:data_request_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/data_requests/:data_request_id') do |req|
req.body = "{\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"email\": \"\",\n \"fields\": [],\n \"metadata\": {},\n \"name\": \"\",\n \"order\": 0\n}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/data_requests/:data_request_id";
let payload = json!({
"auth_phone_number_hash": "",
"auth_provider": "",
"auth_second_factor_type": "",
"auth_session_id_hash": "",
"auth_session_started_at": "",
"auth_type": "",
"auth_user_id_hash": "",
"auth_username_hash": "",
"email": "",
"fields": (),
"metadata": json!({}),
"name": "",
"order": 0
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/data_requests/:data_request_id \
--header 'content-type: application/json' \
--data '{
"auth_phone_number_hash": "",
"auth_provider": "",
"auth_second_factor_type": "",
"auth_session_id_hash": "",
"auth_session_started_at": "",
"auth_type": "",
"auth_user_id_hash": "",
"auth_username_hash": "",
"email": "",
"fields": [],
"metadata": {},
"name": "",
"order": 0
}'echo '{
"auth_phone_number_hash": "",
"auth_provider": "",
"auth_second_factor_type": "",
"auth_session_id_hash": "",
"auth_session_started_at": "",
"auth_type": "",
"auth_user_id_hash": "",
"auth_username_hash": "",
"email": "",
"fields": [],
"metadata": {},
"name": "",
"order": 0
}' | \
http PUT {{baseUrl}}/data_requests/:data_request_id \
content-type:application/jsonwget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "auth_phone_number_hash": "",\n "auth_provider": "",\n "auth_second_factor_type": "",\n "auth_session_id_hash": "",\n "auth_session_started_at": "",\n "auth_type": "",\n "auth_user_id_hash": "",\n "auth_username_hash": "",\n "email": "",\n "fields": [],\n "metadata": {},\n "name": "",\n "order": 0\n}' \
--output-document \
- {{baseUrl}}/data_requests/:data_request_idimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"auth_phone_number_hash": "",
"auth_provider": "",
"auth_second_factor_type": "",
"auth_session_id_hash": "",
"auth_session_started_at": "",
"auth_type": "",
"auth_user_id_hash": "",
"auth_username_hash": "",
"email": "",
"fields": [],
"metadata": [],
"name": "",
"order": 0
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/data_requests/:data_request_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data_request": {
"auth_phone_number_hash": null,
"auth_provider": "google",
"auth_second_factor_type": "none",
"auth_session_id_hash": "8d969eef6ecad3c29a3a629280e686cf0c3f5d5a86aff3ca12020c923adc6c92",
"auth_session_started_at": "2018-10-23T13:00:00Z",
"auth_type": "oauth",
"auth_user_id_hash": null,
"auth_username_hash": null,
"completed_at": null,
"data": {
"last_name": "Smithers"
},
"email": "jdoe@example.com",
"fields": [
"last_name"
],
"id": "drq_000000000000000001",
"ip_address": "1.1.1.1",
"metadata": {
"user_id": 123
},
"name": "John Doe",
"order": 1,
"sort_order": 0,
"state": "pending",
"submission_id": "sub_000000000000000001",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.122 Safari/537.36",
"viewed_at": null
},
"status": "success"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Invalid API token secret"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"error": "Data request not found.",
"status": "error"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"errors": [
"Data requests cannot be updated after they have been completed."
],
"status": "error"
}