Create a Document on a Workflow

post

https://na1.ironcladapp.com/public/api/v1/workflows/{id}/documents/{attributeId}

Create a document in the specified workflow attribute. If a document key to an existing draft document is provided, the new file will be uploaded as a new version of the existing document. For all other non-draft documents and when document key is absent, this operation will only append the new document to the document attribute array. Please note that to upload a signed document, reference the Create a Signed Document on a Workflow endpoint.

OAuth Scope required: public.workflows.createDocuments

Path Params

string

required

The unique identifier of a workflow

attributeId

string

required

The file attribute (e.g. "draft", "myFileField") - "document" type attributes can be found in the schema portion of the Retrieve a Workflow response.

Body Params

attachment

file

required

Must be a binary. Base64 is not accepted at this time.

metadata

object

required

A JSON string that contains all the metadata for the Document.

Headers

x-as-user-email

string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-id

string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Responses

Language

Credentials

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

204204

400400

404404