SMsmokeball
Tasks

Create a task document

Links the specified document to the specified task.

post/tasks/{taskId}/documents

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/tasks/{taskId}/documents
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

taskIdstring uuid required

Request body

documentIdstring nullable

Unique identifier of the document (file or memo).

If a file, the type must be 0 (File).

If a memo, the type must be 2 (Memo).

The FormTemplate (1) document type is not currently supported for task document creation.

type0 | 1 | 2 required

Available document types: "File = 0", "FormTemplate = 1", "Memo = 2"

The FormTemplate (1) document type is not currently supported for task document creation.

Example request

{
  "documentId": "cf666f06-3ff2-4a41-8c7f-ab5a8bc6a277"
}

Response

When request is accepted. Returns a hypermedia 'Link' object of the link to be created.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

No recorded changes to this operation across all 15 revisions of this API.