Skip to main content
PATCH
/
api
/
orgs
/
{id}
/
issues
/
{issueId}
Update issue
curl --request PATCH \
  --url https://atollhq.com/api/orgs/{id}/issues/{issueId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "status": "<string>",
  "assigneeId": "<string>",
  "assigneeIds": [
    "<string>"
  ],
  "projectId": "<string>",
  "milestoneId": "<string>",
  "teamId": "<string>",
  "startDate": "2023-12-25",
  "dueDate": "2023-12-25",
  "recurrenceInterval": 123,
  "comment_body": "<string>",
  "comment_mentions": [
    {
      "member_id": "<string>"
    }
  ],
  "commentBody": "<string>"
}
'
{
  "mentions": {
    "requested": 123,
    "created": 123,
    "skipped": [
      {
        "member_id": "<string>"
      }
    ]
  }
}

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
priority
enum<integer>
Available options:
0,
1,
2,
3
assigneeId
string
assigneeIds
string[]
projectId
string
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.

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.

commentBody
string

camelCase alias for comment_body.

Response

Successful response

mentions
object