Templates API: List, Retrieve, Create, Update, and Delete Templates

curl -H 'Authorization: Bearer YOUR_SECRET_KEY' \
  'https://api.pdfmonkey.io/api/v1/document_template_cards?q[workspace_id]=3161c5e5-9966-4630-9b07-63f718092784'

cards = Pdfmonkey::Template.list_cards(
  workspace_id: '3161c5e5-9966-4630-9b07-63f718092784'
)

cards.each { |card| puts card.identifier }

const response = await fetch(
  'https://api.pdfmonkey.io/api/v1/document_template_cards?q[workspace_id]=3161c5e5-9966-4630-9b07-63f718092784',
  {
    headers: {
      'Authorization': 'Bearer YOUR_SECRET_KEY',
    },
  }
);

const data = await response.json();
console.log(data.document_template_cards);

import requests

response = requests.get(
    'https://api.pdfmonkey.io/api/v1/document_template_cards',
    headers={
        'Authorization': 'Bearer YOUR_SECRET_KEY',
    },
    params={
        'q[workspace_id]': '3161c5e5-9966-4630-9b07-63f718092784',
    },
)

data = response.json()
print(data['document_template_cards'])

<?php
$ch = curl_init('https://api.pdfmonkey.io/api/v1/document_template_cards?q[workspace_id]=3161c5e5-9966-4630-9b07-63f718092784');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_SECRET_KEY',
    ],
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data['document_template_cards']);

curl -H 'Authorization: Bearer YOUR_SECRET_KEY' \
  https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9

template = Pdfmonkey::Template.fetch('8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9')

puts template.identifier
puts template.body
puts template.settings

const response = await fetch(
  'https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9',
  {
    headers: {
      'Authorization': 'Bearer YOUR_SECRET_KEY',
    },
  }
);

const data = await response.json();
console.log(data.document_template);

import requests

response = requests.get(
    'https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9',
    headers={
        'Authorization': 'Bearer YOUR_SECRET_KEY',
    },
)

data = response.json()
print(data['document_template'])

<?php
$ch = curl_init('https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_SECRET_KEY',
    ],
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data['document_template']);

curl https://api.pdfmonkey.io/api/v1/document_templates \
  -X POST \
  -H 'Authorization: Bearer YOUR_SECRET_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "document_template": {
      "app_id": "3161c5e5-9966-4630-9b07-63f718092784",
      "identifier": "Invoice Template",
      "body_draft": "<h1>Invoice #{{number}}</h1><p>Total: {{total}}</p>",
      "scss_style_draft": "h1 { color: #333; }",
      "sample_data_draft": "{ \"number\": \"INV-001\", \"total\": \"$123.50\" }",
      "settings_draft": {
        "paper_format": "a4",
        "orientation": "portrait",
        "margin": { "top": 20, "bottom": 20, "left": 15, "right": 15 }
      }
    }
  }'

template = Pdfmonkey::Template.create(
  workspace_id: '3161c5e5-9966-4630-9b07-63f718092784',
  identifier: 'Invoice Template',
  body: '<h1>Invoice #{{number}}</h1><p>Total: {{total}}</p>',
  scss_style: 'h1 { color: #333; }',
  sample_data: '{ "number": "INV-001", "total": "$123.50" }',
  settings: {
    paper_format: 'a4',
    orientation: 'portrait',
    margin: { top: 20, bottom: 20, left: 15, right: 15 },
  },
)

puts template.id

const response = await fetch('https://api.pdfmonkey.io/api/v1/document_templates', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_SECRET_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    document_template: {
      app_id: '3161c5e5-9966-4630-9b07-63f718092784',
      identifier: 'Invoice Template',
      body_draft: '<h1>Invoice #{{number}}</h1><p>Total: {{total}}</p>',
      scss_style_draft: 'h1 { color: #333; }',
      sample_data_draft: '{ "number": "INV-001", "total": "$123.50" }',
      settings_draft: {
        paper_format: 'a4',
        orientation: 'portrait',
        margin: { top: 20, bottom: 20, left: 15, right: 15 },
      },
    },
  }),
});

const data = await response.json();
console.log(data.document_template);

import requests

response = requests.post(
    'https://api.pdfmonkey.io/api/v1/document_templates',
    headers={
        'Authorization': 'Bearer YOUR_SECRET_KEY',
    },
    json={
        'document_template': {
            'app_id': '3161c5e5-9966-4630-9b07-63f718092784',
            'identifier': 'Invoice Template',
            'body_draft': '<h1>Invoice #{{number}}</h1><p>Total: {{total}}</p>',
            'scss_style_draft': 'h1 { color: #333; }',
            'sample_data_draft': '{ "number": "INV-001", "total": "$123.50" }',
            'settings_draft': {
                'paper_format': 'a4',
                'orientation': 'portrait',
                'margin': {'top': 20, 'bottom': 20, 'left': 15, 'right': 15},
            },
        },
    },
)

data = response.json()
print(data['document_template'])

<?php
$ch = curl_init('https://api.pdfmonkey.io/api/v1/document_templates');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_SECRET_KEY',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'document_template' => [
            'app_id' => '3161c5e5-9966-4630-9b07-63f718092784',
            'identifier' => 'Invoice Template',
            'body_draft' => '<h1>Invoice #{{number}}</h1><p>Total: {{total}}</p>',
            'scss_style_draft' => 'h1 { color: #333; }',
            'sample_data_draft' => '{ "number": "INV-001", "total": "$123.50" }',
            'settings_draft' => [
                'paper_format' => 'a4',
                'orientation' => 'portrait',
                'margin' => ['top' => 20, 'bottom' => 20, 'left' => 15, 'right' => 15],
            ],
        ],
    ]),
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data['document_template']);

curl https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9 \
  -X PUT \
  -H 'Authorization: Bearer YOUR_SECRET_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "document_template": {
      "body_draft": "<h1>Invoice #{{number}}</h1><p>Due: {{due_date}}</p><p>Total: {{total}}</p>",
      "sample_data_draft": "{ \"number\": \"INV-001\", \"due_date\": \"2050-04-01\", \"total\": \"$123.50\" }"
    }
  }'

template = Pdfmonkey::Template.fetch('8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9')

template.update!(
  body: '<h1>Invoice #{{number}}</h1><p>Due: {{due_date}}</p><p>Total: {{total}}</p>',
  sample_data: '{ "number": "INV-001", "due_date": "2050-04-01", "total": "$123.50" }',
)

const response = await fetch(
  'https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_SECRET_KEY',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      document_template: {
        body_draft: '<h1>Invoice #{{number}}</h1><p>Due: {{due_date}}</p><p>Total: {{total}}</p>',
        sample_data_draft: '{ "number": "INV-001", "due_date": "2050-04-01", "total": "$123.50" }',
      },
    }),
  }
);

const data = await response.json();
console.log(data.document_template);

import requests

response = requests.put(
    'https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9',
    headers={
        'Authorization': 'Bearer YOUR_SECRET_KEY',
    },
    json={
        'document_template': {
            'body_draft': '<h1>Invoice #{{number}}</h1><p>Due: {{due_date}}</p><p>Total: {{total}}</p>',
            'sample_data_draft': '{ "number": "INV-001", "due_date": "2050-04-01", "total": "$123.50" }',
        },
    },
)

data = response.json()
print(data['document_template'])

<?php
$ch = curl_init('https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_SECRET_KEY',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'document_template' => [
            'body_draft' => '<h1>Invoice #{{number}}</h1><p>Due: {{due_date}}</p><p>Total: {{total}}</p>',
            'sample_data_draft' => '{ "number": "INV-001", "due_date": "2050-04-01", "total": "$123.50" }',
        ],
    ]),
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data['document_template']);

curl https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9 \
  -X DELETE \
  -H 'Authorization: Bearer YOUR_SECRET_KEY'

Pdfmonkey::Template.delete('8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9')

const response = await fetch(
  'https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9',
  {
    method: 'DELETE',
    headers: {
      'Authorization': 'Bearer YOUR_SECRET_KEY',
    },
  }
);

console.log(response.status); // => 204

import requests

response = requests.delete(
    'https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9',
    headers={
        'Authorization': 'Bearer YOUR_SECRET_KEY',
    },
)

print(response.status_code)  # => 204

<?php
$ch = curl_init('https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_SECRET_KEY',
    ],
]);

curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE); // => 204
curl_close($ch);