Jump to Content
InkitGuidesAPIChangelogStatus
GuidesAPIChangelog
GuidesAPIChangelogStatusSign InSign UpInkit
Sign InSign Up

Getting started

  • Welcome to Inkit

Document Geneneration Platform

  • Welcome to Inkit
    • About Inkit
    • Who this documentation is for
  • Getting started with Inkit
    • User signup options
    • Users and API keys
    • Default admin role
  • Managing API keys
    • Why Inkit Render uses API keys
    • Add an API key to your account
    • Remove an API key from your account
    • Regenerate API keys
    • When you lose your API key
    • Store your API keys
  • Organizing data with folders
    • Folders and their settings
    • Default folder
    • Create a folder
    • Edit a folder
    • Delete a folder
    • Share or unshare a folder
    • Identify private folder needs
  • Integrating systems with the API
    • Identify API key needs
  • Managing roles
    • Assign a role to a user
    • Create a role
    • Utilizing roles
    • Overview of permissions
    • Identify permission needs
    • Add roles to your API key
    • Remove roles from your API key
  • Turning HTML files into PDFs
    • Data requirements
    • Document sizes and measurement support
    • Turn an HTML file into a PDF
    • Automatically place your completed PDFs in a folder
  • Pulling rendered PDFs from the API
    • Pull a PDF from the API
    • Render IDs
  • Document streaming
    • Stream a document
  • Disappearing documents
    • Document expiration and self-deletion
    • Expire after N number of views
    • Expire on a specific date
    • Expire a document by API request
  • Merging dynamic content into PDFs
    • HTML templates
    • Generate a document from a template
    • Create a template
    • Edit a template
    • Delete a template
  • Subscribing to events with webhooks
    • Utilizing webhooks
    • Set up a webhook to an event
    • Storing webhook authentication secrets
  • Setting up payment methods
    • Discover the different plans
  • Connect with Salesforce
    • Installing the Inkit package
    • Add your API key to Salesforce
    • Setting up a template to use your Salesforce data
    • Adding the Create Render button to a page
    • Generate documents from a Process Builder
  • Sending physical postcards or letters
    • Physical mail quickstart guide
    • Postcard & letter product specs
    • Authentication
    • Postcards
    • Postcard templates
    • Letters
    • Letter templates
    • Upload file size
    • Dynamic images
    • Expected send times
  • SDK guides
  • API reference

Additional Resources

  • API response codes
  • Security

Managing roles

Suggest Edits

In this section of the documentation, you will read about roles, their management, and how they affect user or system their permissions.

Topics include:

  • Utilizing roles
  • Identify permission needs
  • Overview of permissions
  • Create a role
  • Assign a role to a user
  • Add roles to your API key
  • Remove a role from your API key

Updated about 1 year ago