Standard API request and response objects

The following request objects apply when generating documents in Inkit through the API:

• merge_parameters
• destinations

The following response objects apply when retrieving lists of documents, batches, folders and templates through the API:

• metadata

merge_parameters

The merge_paremeters object is where you store the key-value pairs that you'll use when generating your document. It will replace the fields that you have embedded in your document template with the data you supply here.

For example:

{
  "merge_parameters": {
    "Name": "John"
  }
}

If you use the above merge_paremeters when you generate your document, Inkit will replace the field Name in your template with John.

destinations

The destinations object is where you provide details on how and where you want to store a generated document.

📘

Note: You can specify multiple destinations when generating a document.

Inkit Storage

You specify data related to an Inkit Storage destination in a subobject called inkit_storage, which has the following properties:

retain_for

For example:

{
  "destinations": {
    "inkit_storage": {
      "retain_for": {
        "hours": 1
      },
      "name": "Mail Merge",
      "folder_id": "fold_6UpetHRzr73eyl4jCbfYBl",
      "expire_after_n_views": 1
    }
  }
}

If you use the above destinations object when generating your document, Inkit will save the document as Mail Merge and will place it in the folder specified by the ID fold_6UpetHRzr73eyl4jCbfYBl. The document will expire either after one view or one hour after its generation, whichever comes first.

Salesforce

You specify data related to a Salesforce destination in a subobject called salesforce, which has the following properties:

For example:

{
  "destinations": {
    "salesforce": {
      "record_id": "Your salesforce LinkedEntityId",
      "salesforce_type": "link",
      "file_name": "My awesome PDF",
      "description": "Salesforce PDF description"
    }
  }
}

Sepire

You specify data related to a Sepire destination in a subobject called sepire, which has the following properties:

mail_product_data

For example:

{
  "destinations": {
    "sepire": {
      "address_line_1": "1234 Main St.",
      "address_line_2": "#1",
      "address_city": "New York",
      "address_zip": "10001",
      "address_state": "NY",
      "address_country": "US",
      "first_name": "John",
      "last_name": "Doe",
      "verify_address": true,
      "mail_product_name": "letter",
      "mail_product_data": {
        "mail_type": "usps_first_class",
        "letter_address_placement": "top_first_page",
        "letter_return_envelope": true,
        "letter_perforated": 1,
        "letter_double_sided": true,
        "letter_color": true,
        "letter_additional_service": "certified",
      }
    }
  }
}

DocuSign

You specify data related to a DocuSign destination in a subobject called docusign, which has the following properties:

signers

[id]

copy_receivers

For example:

{
  "destinations": {
    "docusign": {
      "signers": {
        "1": {
          "name": "John Doe",
          "email": "[email protected]",
          "routing_number": 2
        },
        "2": {
          "name": "Sally Smith",
          "email": "[email protected]",
          "routing_number": 1
        }
      },
      "copy_receivers": [{
        "name": "Tom Jones",
        "email": "[email protected]"
      }],
      "routing": "ordered"
    }
  }
}

Magic Link

You specify data related to a Magic Link destination in a subobject called magic_link, which has the following properties:

retain_from_created and retain_from_first_opened

For example:

{
  "destinations": {
    "magic_link": {
      "retain_from_created": {
        "hours": 1
      },
      "auth_email": "[email protected]",
      "recipient_email": "[email protected]",
      "auth_method": "email",
      "name": "Mail Merge",
      "expire_after_n_views": 1
    }
  }
}

Amazon S3

You specify data related to an Amazon S3 destination in a subobject called amazon_s3, which has the following properties:

For example:

{
  "destinations": {
    "amazon_s3": {
      "bucket_name": "mybucket",
      "file_name": "test",
    }
  }
}

Google Drive

You specify data related to an Google Drive destination in a subobject called google_drive, which has the following properties:

For example:

{
  "destinations": {
    "google_drive": {
      "folder_id": "12HCqdH7SEJT7USqIpmxqcyn0m3gDTu8b",
      "file_name": "test",
    }
  }
}

Dropbox

You specify data related to an Dropbox destination in a subobject called dropbox, which has the following properties:

For example:

{
  "destinations": {
    "dropbox": {
      "path": "/",
      "file_name": "test",
    }
  }
}

Box

You specify data related to an Box destination in a subobject called box, which has the following properties:

For example:

{
  "destinations": {
    "box": {
      "parent_id": "0",
      "file_name": "test",
    }
  }
}

metadata

All list methods in the Inkit API return a metadata object that has the following properties:

pagination

sort

For example:

{
  "metadata": {
    "pagination": {
      "current_page": 1,
      "next_page": 2,
      "page_count": 3,
      "page_size": 25,
      "prev_page": 3,
      "total_count": 64
    },
    "sort": {
      "key": "modified_at",
      "order": 1
    }
  }
}