Create draft

POST/workspaces/{organizationId}/drafts

Path parameters

organizationIdstringrequired

Request body

application/json

entityTypestringrequired

Allowed:issuedealcustomer

entityIdstringrequired

issueIdstring

kindstringrequired

Allowed:commentfield_changemessageartifact

payloadobjectrequired

sessionIdstring

agentSlugstring

promptVersionstring

Responses

201

Draft created pending review — for artifact kinds, nothing reaches the merchant until a human publishes

idstringrequired

organizationIdstringrequired

entityTypestringrequired

entityIdstringrequired

issueIdstring | nullrequired

kindstringrequired

Allowed:commentfield_changemessageartifact

payloadobjectrequired

statusstringrequired

Allowed:pendingpublisheddiscarded

createdByIdstring | nullrequired

sessionIdstring | nullrequired

reviewedByIdstring | nullrequired

reviewedAtstring | nullrequired

reviewNotestring | nullrequired

publishedCommentIdstring | nullrequired

agentSlugstring | nullrequired

promptVersionstring | nullrequired

originalPayloadobject | nullrequired

slaBreachedbooleanrequired

createdAtstringrequired

updatedAtstringrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*

Bodyapplication/json

Request body

Request

curl -X POST '/workspaces/string/drafts' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "entityType": "issue",
  "entityId": "string",
  "issueId": "string",
  "kind": "comment",
  "payload": {
    "property1": null,
    "property2": null
  },
  "sessionId": "string",
  "agentSlug": "string",
  "promptVersion": "string"
}'

const response = await fetch("/workspaces/string/drafts", {
  method: "POST",
  headers: {
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"entityType\": \"issue\",\n  \"entityId\": \"string\",\n  \"issueId\": \"string\",\n  \"kind\": \"comment\",\n  \"payload\": {\n    \"property1\": null,\n    \"property2\": null\n  },\n  \"sessionId\": \"string\",\n  \"agentSlug\": \"string\",\n  \"promptVersion\": \"string\"\n}"
});

import requests

response = requests.post(
    "/workspaces/string/drafts",
    headers={
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"entityType\": \"issue\",\n  \"entityId\": \"string\",\n  \"issueId\": \"string\",\n  \"kind\": \"comment\",\n  \"payload\": {\n    \"property1\": null,\n    \"property2\": null\n  },\n  \"sessionId\": \"string\",\n  \"agentSlug\": \"string\",\n  \"promptVersion\": \"string\"\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",
  "agentSlug": "string",
  "promptVersion": "string",
  "originalPayload": {
    "property1": null,
    "property2": null
  },
  "slaBreached": true,
  "createdAt": "string",
  "updatedAt": "string"
}