Skip to main content
PATCH
Update issue

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

id identifier

issueId
string
required

issueId identifier

Body

application/json
title
string
description
string
status
string

Stored project board-column key, not the visible label. Membership is validated against the selected project's live workflow.

Pattern: ^[a-z0-9_]+$
priority
enum<integer>
Available options:
0,
1,
2,
3
assigneeId
string
assigneeIds
string[]
projectId
string | null

Set to a project UUID to move the issue, or null for a projectless issue. A projectless move is rejected when the issue blocks dependencies because release points require a blocker project.

dependencyReleaseMappings
object[]

Required when moving a blocker to another project: one destination release column for every blocking dependency. The update is atomic. Item aliases dependency_id and release_column_id are also accepted.

One dependency release mapping. Use camelCase or snake_case field names; both forms may be mixed for compatibility.

dependency_release_mappings
object[]

Snake-case compatibility alias for dependencyReleaseMappings. Items accept dependency_id or dependencyId and release_column_id or releaseColumnId.

One dependency release mapping. Use camelCase or snake_case field names; both forms may be mixed for compatibility.

releaseColumnMappings
object[]

Legacy compatibility alias for dependencyReleaseMappings. Items accept dependency_id or dependencyId and release_column_id or releaseColumnId.

One dependency release mapping. Use camelCase or snake_case field names; both forms may be mixed for compatibility.

milestoneId
string
teamId
string
startDate
string<date>
dueDate
string<date>

Date-only due date in YYYY-MM-DD format.

recurrenceType
enum<string>

Recurring task cadence. Use recurrenceInterval with custom to specify days.

Available options:
daily,
weekly,
biweekly,
monthly,
custom
recurrenceInterval
integer

Custom recurrence interval in days.

recurrenceDays
enum<string>[] | null

Set selected weekdays for weekly recurrence, or null/[] to return the series to its due-date weekday.

Available options:
mon,
tue,
wed,
thu,
fri,
sat,
sun
comment_body
string

Optional Markdown/plain text or rich-text HTML issue comment body created in the same authenticated issue update request. Stored and returned as sanitized HTML; rejected when sanitization leaves no visible text or safe media. Use this to preserve durable progress evidence when changing status.

comment_mentions
object[]

Structured mentions for the comment created by comment_body. Each member_id is the stable Atoll org member ID, not an auth user ID or display name.

comment_source_metadata
object

Hidden routing provenance for agent-authored comments. Omit this object unless the host exposes a real thread or session ID, and never invent one. Contains harness identifiers only; never include credentials, prompts, or arbitrary runtime state.

commentSourceMetadata
object

Hidden routing provenance for agent-authored comments. Omit this object unless the host exposes a real thread or session ID, and never invent one. Contains harness identifiers only; never include credentials, prompts, or arbitrary runtime state.

commentBody
string

camelCase alias for comment_body.

Response

Successful response

issue
object
required
comment
object
outcome
object
mentions
object