Update draft

PATCH/workspaces/{organizationId}/drafts/{id}

Path parameters

organizationIdstringrequired

idstringrequired

Request body

application/json

payloadobjectrequired

Responses

200

Draft payload updated

idstringrequired

organizationIdstringrequired

entityTypestringrequired

entityIdstringrequired

issueIdstring | nullrequired

kindstringrequired

Allowed:commentfield_changemessage

payloadobjectrequired

statusstringrequired

Allowed:pendingpublisheddiscarded

createdByIdstring | nullrequired

sessionIdstring | nullrequired

reviewedByIdstring | nullrequired

reviewedAtstring | nullrequired

reviewNotestring | nullrequired

publishedCommentIdstring | nullrequired

createdAtstringrequired

updatedAtstringrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*idpath*

Bodyapplication/json

Request body

Request

curl -X PATCH '/workspaces/string/drafts/string' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "payload": {
    "property1": null,
    "property2": null
  }
}'

const response = await fetch("/workspaces/string/drafts/string", {
  method: "PATCH",
  headers: {
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"payload\": {\n    \"property1\": null,\n    \"property2\": null\n  }\n}"
});

import requests

response = requests.patch(
    "/workspaces/string/drafts/string",
    headers={
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"payload\": {\n    \"property1\": null,\n    \"property2\": null\n  }\n}",
)

Response

{
  "id": "string",
  "organizationId": "string",
  "entityType": "string",
  "entityId": "string",
  "issueId": "string",
  "kind": "comment",
  "payload": {
    "property1": null,
    "property2": null
  },
  "status": "pending",
  "createdById": "string",
  "sessionId": "string",
  "reviewedById": "string",
  "reviewedAt": "string",
  "reviewNote": "string",
  "publishedCommentId": "string",
  "createdAt": "string",
  "updatedAt": "string"
}