Ruby / PandaDoc API Reference / Create Document from PandaDoc Template (Full API Sample Document from PandaDoc Template)
Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "name": "Full API Sample Document from PandaDoc Template",
# "template_uuid": "{{template_id}}",
# "owner": {
# "membership_id": "{{membership_id}}"
# },
# "recipients": [
# {
# "email": "{{recipient_email}}",
# "first_name": "Josh",
# "last_name": "Ron",
# "role": "user",
# "signing_order": 1
# }
# ],
# "tokens": [
# {
# "name": "Favorite.Pet",
# "value": "Panda"
# }
# ],
# "fields": {
# "Favorite.Color": {
# "value": "PandaDoc green"
# },
# "Delivery": {
# "value": "Same Day Delivery"
# },
# "Like": {
# "value": true
# },
# "Date": {
# "value": "2019-12-31T00:00:00.000Z"
# }
# },
# "metadata": {
# "my_favorite_pet": "Panda"
# },
# "tags": [
# "created_via_api",
# "test_document"
# ],
# "images": [
# {
# "name": "Image 1",
# "urls": [
# "https://s3.amazonaws.com/pd-static-content/public-docs/pandadoc-panda-bear.png"
# ]
# }
# ],
# "pricing_tables": [
# {
# "name": "Pricing Table 1",
# "data_merge": true,
# "options": {
# "discount": {
# "type": "absolute",
# "name": "Discount",
# "value": 2.26
# }
# },
# "sections": [
# {
# "title": "Sample Section",
# "default": true,
# "rows": [
# {
# "options": {
# "optional": true,
# "optional_selected": true,
# "qty_editable": true
# },
# "data": {
# "Name": "Toy Panda",
# "Description": "Fluffy!",
# "Price": 10,
# "QTY": 3,
# "Tax1": {
# "value": 7.5,
# "type": "percent"
# }
# },
# "custom_fields": {
# "Fluffiness": "5 / 5"
# }
# }
# ]
# }
# ]
# }
# ],
# "content_placeholders": [
# {
# "block_id": "{{block_id}}",
# "content_library_items": [
# {
# "id": "{{cli_id}}",
# "pricing_tables": [
# {
# "name": "Pricing Table 1",
# "data_merge": true,
# "options": {
# "discount": {
# "type": "absolute",
# "name": "Discount",
# "value": 2.26
# }
# },
# "sections": [
# {
# "title": "Sample Section",
# "default": true,
# "rows": [
# {
# "options": {
# "optional": true,
# "optional_selected": true,
# "qty_editable": true
# },
# "data": {
# "Name": "Placeholder Panda",
# "Price": 10,
# "QTY": 3
# }
# }
# ]
# }
# ]
# }
# ]
# },
# {
# "id": "{{cli_id_2}}",
# "recipients": [
# {
# "email": "john@example.com",
# "first_name": "John",
# "last_name": "Roe",
# "role": "Signer",
# "signing_order": 2
# }
# ],
# "fields": {
# "Date": {
# "value": "2019-12-31T00:00:00.000Z"
# }
# }
# }
# ]
# }
# ]
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("name","Full API Sample Document from PandaDoc Template")
json.UpdateString("template_uuid","{{template_id}}")
json.UpdateString("owner.membership_id","{{membership_id}}")
json.UpdateString("recipients[0].email","{{recipient_email}}")
json.UpdateString("recipients[0].first_name","Josh")
json.UpdateString("recipients[0].last_name","Ron")
json.UpdateString("recipients[0].role","user")
json.UpdateInt("recipients[0].signing_order",1)
json.UpdateString("tokens[0].name","Favorite.Pet")
json.UpdateString("tokens[0].value","Panda")
json.UpdateString("fields.\"Favorite.Color\".value","PandaDoc green")
json.UpdateString("fields.Delivery.value","Same Day Delivery")
json.UpdateBool("fields.Like.value",true)
json.UpdateString("fields.Date.value","2019-12-31T00:00:00.000Z")
json.UpdateString("metadata.my_favorite_pet","Panda")
json.UpdateString("tags[0]","created_via_api")
json.UpdateString("tags[1]","test_document")
json.UpdateString("images[0].name","Image 1")
json.UpdateString("images[0].urls[0]","https://s3.amazonaws.com/pd-static-content/public-docs/pandadoc-panda-bear.png")
json.UpdateString("pricing_tables[0].name","Pricing Table 1")
json.UpdateBool("pricing_tables[0].data_merge",true)
json.UpdateString("pricing_tables[0].options.discount.type","absolute")
json.UpdateString("pricing_tables[0].options.discount.name","Discount")
json.UpdateNumber("pricing_tables[0].options.discount.value","2.26")
json.UpdateString("pricing_tables[0].sections[0].title","Sample Section")
json.UpdateBool("pricing_tables[0].sections[0].default",true)
json.UpdateBool("pricing_tables[0].sections[0].rows[0].options.optional",true)
json.UpdateBool("pricing_tables[0].sections[0].rows[0].options.optional_selected",true)
json.UpdateBool("pricing_tables[0].sections[0].rows[0].options.qty_editable",true)
json.UpdateString("pricing_tables[0].sections[0].rows[0].data.Name","Toy Panda")
json.UpdateString("pricing_tables[0].sections[0].rows[0].data.Description","Fluffy!")
json.UpdateInt("pricing_tables[0].sections[0].rows[0].data.Price",10)
json.UpdateInt("pricing_tables[0].sections[0].rows[0].data.QTY",3)
json.UpdateNumber("pricing_tables[0].sections[0].rows[0].data.Tax1.value","7.5")
json.UpdateString("pricing_tables[0].sections[0].rows[0].data.Tax1.type","percent")
json.UpdateString("pricing_tables[0].sections[0].rows[0].custom_fields.Fluffiness","5 / 5")
json.UpdateString("content_placeholders[0].block_id","{{block_id}}")
json.UpdateString("content_placeholders[0].content_library_items[0].id","{{cli_id}}")
json.UpdateString("content_placeholders[0].content_library_items[0].pricing_tables[0].name","Pricing Table 1")
json.UpdateBool("content_placeholders[0].content_library_items[0].pricing_tables[0].data_merge",true)
json.UpdateString("content_placeholders[0].content_library_items[0].pricing_tables[0].options.discount.type","absolute")
json.UpdateString("content_placeholders[0].content_library_items[0].pricing_tables[0].options.discount.name","Discount")
json.UpdateNumber("content_placeholders[0].content_library_items[0].pricing_tables[0].options.discount.value","2.26")
json.UpdateString("content_placeholders[0].content_library_items[0].pricing_tables[0].sections[0].title","Sample Section")
json.UpdateBool("content_placeholders[0].content_library_items[0].pricing_tables[0].sections[0].default",true)
json.UpdateBool("content_placeholders[0].content_library_items[0].pricing_tables[0].sections[0].rows[0].options.optional",true)
json.UpdateBool("content_placeholders[0].content_library_items[0].pricing_tables[0].sections[0].rows[0].options.optional_selected",true)
json.UpdateBool("content_placeholders[0].content_library_items[0].pricing_tables[0].sections[0].rows[0].options.qty_editable",true)
json.UpdateString("content_placeholders[0].content_library_items[0].pricing_tables[0].sections[0].rows[0].data.Name","Placeholder Panda")
json.UpdateInt("content_placeholders[0].content_library_items[0].pricing_tables[0].sections[0].rows[0].data.Price",10)
json.UpdateInt("content_placeholders[0].content_library_items[0].pricing_tables[0].sections[0].rows[0].data.QTY",3)
json.UpdateString("content_placeholders[0].content_library_items[1].id","{{cli_id_2}}")
json.UpdateString("content_placeholders[0].content_library_items[1].recipients[0].email","john@example.com")
json.UpdateString("content_placeholders[0].content_library_items[1].recipients[0].first_name","John")
json.UpdateString("content_placeholders[0].content_library_items[1].recipients[0].last_name","Roe")
json.UpdateString("content_placeholders[0].content_library_items[1].recipients[0].role","Signer")
json.UpdateInt("content_placeholders[0].content_library_items[1].recipients[0].signing_order",2)
json.UpdateString("content_placeholders[0].content_library_items[1].fields.Date.value","2019-12-31T00:00:00.000Z")
http.SetRequestHeader("Authorization","API-Key {{api_key}}")
http.SetRequestHeader("Content-Type","application/json")
# resp is a CkHttpResponse
resp = http.PostJson3("https://api.pandadoc.com/public/v1/documents","application/json",json)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";
Curl Command
curl -X POST
-H "Authorization: Bearer {{access_token}}"
-H "Authorization: API-Key {{api_key}}"
-H "Content-Type: application/json"
-d '{
"name": "Full API Sample Document from PandaDoc Template",
"template_uuid": "{{template_id}}",
"owner":{
"membership_id":"{{membership_id}}"
},
"recipients": [
{
"email": "{{recipient_email}}",
"first_name": "Josh",
"last_name": "Ron",
"role": "user",
"signing_order": 1
}
],
"tokens": [
{
"name": "Favorite.Pet",
"value": "Panda"
}
],
"fields": {
"Favorite.Color": {
"value": "PandaDoc green"
},
"Delivery": {
"value": "Same Day Delivery"
},
"Like": {
"value": true
},
"Date": {
"value": "2019-12-31T00:00:00.000Z"
}
},
"metadata": {
"my_favorite_pet": "Panda"
},
"tags": [
"created_via_api",
"test_document"
],
"images": [
{
"name": "Image 1",
"urls": [
"https://s3.amazonaws.com/pd-static-content/public-docs/pandadoc-panda-bear.png"
]
}
],
"pricing_tables": [
{
"name": "Pricing Table 1",
"data_merge":true,
"options": {
"discount": {
"type": "absolute",
"name": "Discount",
"value": 2.26
}
},
"sections": [
{
"title": "Sample Section",
"default": true,
"rows": [
{
"options": {
"optional": true,
"optional_selected": true,
"qty_editable": true
},
"data": {
"Name": "Toy Panda",
"Description": "Fluffy!",
"Price": 10,
"QTY": 3,
"Tax1": {
"value": 7.5,
"type": "percent"
}
},
"custom_fields": {
"Fluffiness": "5 / 5"
}
}
]
}
]
}
],
"content_placeholders": [
{
"block_id": "{{block_id}}",
"content_library_items": [
{
"id": "{{cli_id}}",
"pricing_tables": [
{
"name": "Pricing Table 1",
"data_merge":true,
"options": {
"discount": {
"type": "absolute",
"name": "Discount",
"value": 2.26
}
},
"sections": [
{
"title": "Sample Section",
"default": true,
"rows": [
{
"options": {
"optional": true,
"optional_selected": true,
"qty_editable": true
},
"data": {
"Name": "Placeholder Panda",
"Price": 10,
"QTY": 3
}
}
]
}
]
}
]
},
{
"id": "{{cli_id_2}}",
"recipients": [
{
"email": "john@example.com",
"first_name": "John",
"last_name": "Roe",
"role": "Signer",
"signing_order": 2
}
],
"fields": {
"Date": {
"value": "2019-12-31T00:00:00.000Z"
}
}
}
]
}
]
}'
https://api.pandadoc.com/public/v1/documents
Postman Collection Item JSON
{
"name": "Create Document from PandaDoc Template (Full API Sample Document from PandaDoc Template)",
"event": [
{
"listen": "test",
"script": {
"exec": [
"var jsonData = JSON.parse(responseBody);",
"if (jsonData.uuid !== undefined) {",
" postman.setEnvironmentVariable(\"document_id\", jsonData.uuid);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "Bearer {{access_token}}",
"disabled": true
},
{
"key": "Authorization",
"value": "API-Key {{api_key}}",
"type": "text"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Full API Sample Document from PandaDoc Template\",\n \"template_uuid\": \"{{template_id}}\",\n \"owner\":{\n \"membership_id\":\"{{membership_id}}\"\n },\n \"recipients\": [\n {\n \"email\": \"{{recipient_email}}\",\n \"first_name\": \"Josh\",\n \"last_name\": \"Ron\",\n \"role\": \"user\",\n \"signing_order\": 1\n }\n ],\n \"tokens\": [\n {\n \"name\": \"Favorite.Pet\",\n \"value\": \"Panda\"\n }\n ],\n \"fields\": {\n \"Favorite.Color\": {\n \"value\": \"PandaDoc green\"\n },\n \"Delivery\": {\n \"value\": \"Same Day Delivery\"\n },\n \"Like\": {\n \"value\": true\n },\n \"Date\": {\n \"value\": \"2019-12-31T00:00:00.000Z\"\n }\n },\n \"metadata\": {\n \"my_favorite_pet\": \"Panda\"\n },\n \"tags\": [\n \"created_via_api\",\n \"test_document\"\n ],\n \"images\": [\n {\n \"name\": \"Image 1\",\n \"urls\": [\n \"https://s3.amazonaws.com/pd-static-content/public-docs/pandadoc-panda-bear.png\"\n ]\n }\n ],\n \"pricing_tables\": [\n {\n \"name\": \"Pricing Table 1\",\n \"data_merge\":true,\n \"options\": {\n \"discount\": {\n \"type\": \"absolute\",\n \"name\": \"Discount\",\n \"value\": 2.26\n }\n },\n \"sections\": [\n {\n \"title\": \"Sample Section\",\n \"default\": true,\n \"rows\": [\n {\n \"options\": {\n \"optional\": true,\n \"optional_selected\": true,\n \"qty_editable\": true\n },\n \"data\": {\n \"Name\": \"Toy Panda\",\n \"Description\": \"Fluffy!\",\n \"Price\": 10,\n \"QTY\": 3,\n \"Tax1\": {\n \"value\": 7.5,\n \"type\": \"percent\"\n }\n },\n \"custom_fields\": {\n \"Fluffiness\": \"5 / 5\"\n }\n }\n ]\n }\n ]\n }\n ],\n \"content_placeholders\": [\n {\n \"block_id\": \"{{block_id}}\",\n \"content_library_items\": [\n {\n \"id\": \"{{cli_id}}\",\n \"pricing_tables\": [\n {\n \"name\": \"Pricing Table 1\",\n \"data_merge\":true,\n \"options\": { \n \"discount\": { \n \"type\": \"absolute\",\n \"name\": \"Discount\",\n \"value\": 2.26\n }\n },\n \"sections\": [\n {\n \"title\": \"Sample Section\",\n \"default\": true,\n \"rows\": [\n {\n \"options\": {\n \"optional\": true,\n \"optional_selected\": true,\n \"qty_editable\": true\n },\n \"data\": {\n \"Name\": \"Placeholder Panda\",\n \"Price\": 10,\n \"QTY\": 3\n }\n }\n ]\n }\n ]\n }\n ]\n },\n {\n \"id\": \"{{cli_id_2}}\",\n \"recipients\": [\n {\n \"email\": \"john@example.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Roe\",\n \"role\": \"Signer\",\n \"signing_order\": 2\n }\n ],\n \"fields\": {\n \"Date\": {\n \t \"value\": \"2019-12-31T00:00:00.000Z\"\n }\n }\n }\n ]\n }\n ]\n}"
},
"url": {
"raw": "https://api.pandadoc.com/public/v1/documents",
"protocol": "https",
"host": [
"api",
"pandadoc",
"com"
],
"path": [
"public",
"v1",
"documents"
]
},
"description": "Provide value to variable: template_id ([Postman environments](https://www.getpostman.com/docs/postman/environments_and_globals/manage_environments) is great for it).\n\nFor details and the sample template go to [https://developers.pandadoc.com/v1/reference#create-document-from-pandadoc-template](https://developers.pandadoc.com/v1/reference#create-document-from-pandadoc-template).\n\nFor details of document creation in general go to [https://developers.pandadoc.com/v1/reference#new-document](https://developers.pandadoc.com/v1/reference#new-document)."
},
"response": [
]
}
