Placeholder Usages

Placeholder usages bind a placeholder to a specific field (assignee, subscriber, start date, or due date) on a template task or todo. When the template is instantiated, the resolved placeholder value is written to that field.

Date fields can additionally apply a relative interval offset from the resolved date.

Attributes

created_at string
Response Parameter `sort`

Timestamp when this placeholder usage was created.
field string
Response Request Parameter `filter` Parameter `sort` Enum

The task or todo field this placeholder is mapped to (e.g. assignee, due_date, start_date).

Enum Values (4 values)

  • assignee
    Assignee
  • subscriber
    Subscriber
  • due_date
    Due Date
  • start_date
    Start Date
id integer
Response Parameter `sort`

The unique identifier of this placeholder usage.
interval_direction string
Response Request Parameter `sort` Enum

The direction of the date offset relative to the reference date, either before or after.

Enum Values (2 values)

  • before
    Before
  • after
    After
interval_enabled boolean
Response Request Parameter `filter` Parameter `sort`

Whether the date offset interval is enabled for this placeholder usage.
interval_unit string
Response Request Parameter `sort` Enum

The unit of the date offset interval (day, week, month, or year).

Enum Values (4 values)

  • day
    Day
  • week
    Week
  • month
    Month
  • year
    Year
interval_value integer
Response Request Parameter `sort`

The numeric value of the date offset applied to the target field when using interval mode.
placeholder placeholder
Response

The placeholder associated with this usage.
placeholder_id integer
Response Request Parameter `filter` Parameter `sort`

ID of the placeholder associated with this usage.
project_id integer
Parameter `filter`

ID of the project this placeholder usage is associated with.
skip_weekends boolean
Response Request Parameter `filter` Parameter `sort`

When true, weekends are excluded when calculating date offsets for this placeholder.
target_id integer
Response Parameter `filter` Parameter `sort`

The ID of the target record (task or todo) this placeholder usage applies to.
target_type string
Response Parameter `filter` Parameter `sort`

The type of the target record — Ticket for tasks, Todo for todos.
task task
Response

The task this placeholder usage is linked to, if the target is a task.
task_id integer
Request Parameter `filter`

ID of the task this placeholder usage is linked to, if the target is a task.
todo todo
Response

The todo this placeholder usage is linked to, if the target is a todo.
todo_id integer
Request Parameter `filter`

ID of the todo this placeholder usage is linked to, if the target is a todo.
updated_at string
Response Parameter `sort`

Timestamp when this placeholder usage was last updated.

Examples

Loading example

Operations

GET /api/v2/placeholder_usages
Get placeholder usages
GET /api/v2/placeholder_usages/{id}
Gets a placeholder usage
POST /api/v2/placeholder_usages
Create a placeholder usage
PATCH /api/v2/placeholder_usages/{id}
Update a placeholder usage
DELETE /api/v2/placeholder_usages/{id}
Deletes a placeholder usage