Jump to Content
InkitGuidesAPIChangelogStatus
HomeGuidesRecipesAPIChangelog
GuidesAPIChangelogStatusSign InSign UpInkit
Sign InSign Up

Getting started WITH INKIT

  • Welcome to Inkit
  • About Inkit
  • Signing up for (and into) Inkit
  • Quickstart: Generating your first document

INKIT Document Geneneration Platform

  • Using Salesforce with Inkit
    • Installing the Inkit Salesforce package
    • Inserting your API key into the Inkit Salesforce app
    • Embedding Salesforce fields into your Inkit template
    • Adding a Generate Document button in Salesforce
    • Adding an Inkit Document Viewer in Salesforce
    • Generating documents from Salesforce flows
  • Managing users and roles
    • Adding a user
    • Editing a user
    • Adding a role
    • Editing a role
    • Assigning roles to a user
    • Inkit permissions
  • Managing API keys
    • Adding, editing and removing API keys
    • Generating API keys
    • Storing API keys
    • Specifying API keys in your applications
  • Using the API
    • API endpoints
    • Making API requests
    • Paging through list requests
    • Standard API request and response objects
    • API reference
    • API response codes
    • Python SDK
    • Node.js SDK
    • Generate Document
    • Retrieve Document Information
    • Download Document
    • List Documents
    • Delete Document
    • Generate Document Batch
    • Retrieve Batch Information
    • List Batches
    • List Folders
    • Create Template
    • Retrieve Template Information
    • List Templates
    • Retrieve Mail Piece Status
  • Using webhooks
    • Adding, editing and removing webhooks
    • Processing webhooks on your server
    • Inkit webhook events
    • Storing webhook secret keys
  • Using folders
    • Adding, editing and removing folders
    • Sharing folders
    • Traversing folders
    • Specifying folders when generating documents
  • Creating and editing templates
  • Creating DOCX templates
    • Adding merge fields to a DOCX template
    • Adding basic conditional statements to a DOCX template
    • Iterating through a list or a table in a DOCX template
    • Adding DocuSign fields to a DOCX template
    • Building a full-featured DOCX template
  • Creating HTML templates
    • Adding merge fields to an HTML template
    • Adding basic conditional statements to an HTML template
    • Iterating through a list or a table in an HTML template
    • Adding DocuSign fields to an HTML template
    • Building a full-featured HTML template
  • Creating PDF templates
    • Adding merge fields to a PDF template
    • Adding DocuSign fields to a PDF template
    • Building a full-featured PDF template
  • Generating documents
    • Generating documents using the Inkit web app
    • Generating documents using the Inkit API
    • Generating documents that expire
  • Displaying generated documents
    • Displaying generated documents internally on demand
    • Displaying generated documents through document IDs
    • Displaying generated documents through Magic Links
    • Storing generated documents in your own system and displaying them to your customers
  • Adding Apps to Inkit
    • Installing the Magic Link app
    • Installing the Salesforce app
    • Installing the DocuSign app
    • Installing the Sepire app
    • Hubspot to Inkit integration guide (Legacy)
  • Using Sepire
    • Configuring Sepire
    • Creating a Sepire mail peice
    • Viewing the status of a Sepire mail piece
  • Performing administrative tasks
    • Editing your profile
    • Editing your organization
    • Using audit logs
    • Adding two-factor authentication
  • Sending postcards or letters (Legacy)
    • Physical mail quickstart guide
    • Postcard & letter product specs
    • Authentication
    • Postcards
    • Postcard templates
    • Letters
    • Letter templates
    • Upload file size
    • Dynamic images
    • Expected send times

Additional Resources

  • Inkit's zero-trust security policies

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 2 months ago