Tasks

Creates a task inside a project. Omit task_type for a plain task; see Task types for the native types and the fields each one requires.

post/projects/{project_id}/tasks

Request

  • Base URL
    https://app2.gettruss.io/api/v1
  • URL
    https://app2.gettruss.io/api/v1/projects/{project_id}/tasks
  • Auth
    HTTP bearer

Path parameters

project_idinteger required

Request body

namestring

Name of the task

descriptionstring

Description of the task - supports limited subset of HTML <b>, <ul>, <li>, <br>, and <a>.

due_datestring date-time nullable

When the task is due (ISO 8601). Optional.

document_category_idinteger nullable

Document type to file the task under - see GET /document_categories for the ids. Optional; when omitted Truss infers one from the task name.

task_type'invoice' | 'contact_info_verification' | 'ez_sign'

Omit for a plain task. See Task types for what each value creates.

amount_duestring

Invoice tasks only, and required for them. Amount the client owes in dollars, as a plain decimal string with at most two decimal places - e.g. "1250.00". Must be greater than 0 and no more than 99999.

verification_typesstring[]

contact_info_verification tasks only, and required for them. What the client is asked to confirm - their contact details, their bank accounts, or both.

ez_sign_template_idinteger

ez_sign tasks only. Provide this or a custom body, never both. The engagement letter template to send - see GET /templates?template_type=engagement_letter_template for the ids.

bodystring

ez_sign tasks only. Custom HTML letter body; requires name and must be omitted when ez_sign_template_id is provided. Supports rich text, tables, safe inline styles and images such as <img src="https://example.com/logo.png" alt="Logo" width="180">. Use public HTTPS image URLs or base64 data URIs for PNG, JPEG, GIF or WebP. Images are fetched safely and embedded in the saved letter (at most 10 images, 2 MB each, 5 MB total across the whole request, including bulk requests). Images must be static, at most 4096 pixels per side and 4 megapixels; they are normalized to PNG. Private-network destinations and unsafe redirects are rejected. Scripts, unsafe HTML, and ActionText attachment tags are removed. Use <p> and <br> for paragraphs and line breaks. Standard merge fields are expanded. Custom letters are not linked to a template and cannot use the template-based advanced merge CSV workflow; supply their final custom values here.

all_must_signboolean

ez_sign tasks only. Whether every client on the project must sign, rather than any one of them. Defaults to the template's setting, or false for a custom body.

Response

successfully creates the task.

idinteger
namestring

Name of the task

descriptionstring

Description of the task - supports limited subset of HTML <b>, <ul>, <li>, <br>, and <a>.

status'to_do' | 'pending_review' | 'approved'

Status of the task

due_datestring date-time nullable

When the task is due (ISO 8601). Null when no due date is set.

Changes

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      added the new contact_info_verification enum value to the request property

    • info

      added the new ez_sign enum value to the request property