Launch Flow

Endpoint URL	SDK Method
`https://api.inkit.com/v1/invoke` (POST)	N/A

Request properties

Property	Type	Required	Description
`flow_id`	String	Yes	The ID of the flow that you'll invoke.
`name`	String	No	The execution name of the flow, which you can use to track it.
`merge_paremeters`	Object	Yes	The key-value pairs that you'll use when generating your document. The data you supply here will replace the fields you have embedded in your document template.

Response properties

Property	Type	Description
`amazon_s3_piece_id`	String	The Amazon S3 document ID if the flow contains an Amazon S3 destination.
`box_piece_id`	String	The Box document ID if the flow contains a Box destination.
`document_id`	String	The Inkit Storage document ID.
`docusign_piece_id`	String	The DocuSign document ID if the flow contains a DocuSign destination.
`dropbox_piece_id`	String	The Dropbox document ID if the flow contains a Dropbox destination.
`google_drive_piece_id`	String	The Google Drive document ID if the flow contains a Google Drive. destination.
`id`	String	The invocation ID of the flow.
`magic_link_piece_id`	String	The Magic Link document ID if the flow contains a Magic Link destination.
`mail_piece_id`	String	The Sepire document ID if the flow contains a Sepire destination.
`salesforce_piece_id`	String	The Salesforce document ID if the flow contains a Salesforce destination.

Example request and response

curl --request POST \
     --url https://api.inkit.com/v1/invoke \
     --header 'Content-Type: application/json' \
     --header 'X-Inkit-API-Token: ENTER YOUR API KEY' \
     --header 'accept: application/json' \
     --data '
{
  "flow_id": "ENTER YOUR FLOW ID",
  "name":"test",
  "merge_parameters": {
    "Name": "John"
  }
}
'

{
  "amazon_s3_piece_id": "as3_4m4HJoJxDYhZhMd2Dr6PJ6",
  "box_piece_id": "box_1WIpoK1NJOlHnKz8cTUS0j",
  "document_id": "doc_5VVwNSVFgsscbxJj9N38iL",
  "docusign_piece_id": "docu_4e9atmnEFtU9ZFroXWFSVA",
  "dropbox_piece_id": "dbox_2WPCr80E7rikeSSHhbrcjg",
  "google_drive_piece_id": "gdrv_3cp8Q1466Bew1mbbXqtAF1",
  "id": "rend_V8apYNwxsuMTbkZtmseuu",
  "magic_link_piece_id": "ml_6COWdgnaKCkUv9TUEQa8t8",
  "mail_piece_id": "mp_rAOQGmlnKkxYVGTPzS2id",
  "salesforce_piece_id": "sp_6QVeOhftdLiRcTddt4vrny"
}