EaserixDocs
DevelopersAPI referenceTasksIssues

Update an issue

Partial update. Empty string clears assigneeId / projectId / cycleId / parentId; estimate 0 clears the estimate; a malformed dueDate is 400 (never treated as "clear"). stateId must belong to the issue's team (else 400 "stateId does not belong to this issue's team"); moving to a completed-type state sets completedAt, moving anywhere else clears it. Property changes are recorded as activity entries, and an assignee change notifies the new assignee.

View as Markdown
PATCH
/v1/issues/{id}

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/issues/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "issue": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",    "number": 0,    "title": "string",    "description": "string",    "stateId": "871bb69c-5872-42b2-88b0-72e9da663aaa",    "state": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",      "name": "string",      "type": "backlog",      "color": "string",      "position": 0,      "description": "string",      "canDelete": true    },    "priority": 0,    "assigneeId": "665a9750-71bd-4b96-bacd-9efa4ae022dd",    "assignee": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",      "name": "string",      "email": "string",      "created": "2019-08-24T14:15:22Z"    },    "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",    "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",    "cycleId": "811bdbf8-a42f-4f8c-b62e-39c77332ffe1",    "estimate": 0,    "position": 0,    "dueDate": "2019-08-24",    "labels": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",        "name": "string",        "color": "string"      }    ],    "childCount": 0,    "blockedByCount": 0,    "match": {      "field": "title",      "snippet": [        {          "text": "string",          "hit": true        }      ],      "commentId": "ee0469af-2fa1-4b7e-b5f1-8e711a95821b",      "author": "string",      "at": "2019-08-24T14:15:22Z"    },    "created": "2019-08-24T14:15:22Z",    "modified": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z",    "mentions": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "email": "string"      }    ],    "following": true,    "importedFrom": {      "namespace": "string",      "key": "string"    }  }}

Get an issue

The issue with state, assignee, and labels embedded.

Delete an issue

Soft delete. The issue moves to Recently Deleted (list it with deleted=true) along with every sub-issue at any depth - none is left live and none is orphaned. Comments and attachments are untouched, because nothing about the issue is actually gone yet. A descendant that was already deleted keeps its original timestamp, so its own 30-day clock is not reset. Deleting an already-deleted issue is a 404.