Building a webhook integration? Read the webhook guide for signatures, retries, event schemas, and troubleshooting.

apiHosted AI, explicit consent

Review comment draft

PATCH /api/comment-drafts/{draftId}

Act on a single AI-drafted comment: approve, reject, edit-then-approve, send it live to LinkedIn, or regenerate it with new instructions.

Parameters

workspaceId

string

Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.

draftIdrequired

string

The comment draft UUID.

actionrequired

string

No description.

approve | reject | edit | send | regenerate

edited_comment

string

Required for action=edit. Also usable to override the sent text for action=send.

rejection_reason

string

Optional context for action=reject.

instructions

string

Regeneration guidance for action=regenerate.

allowHostedAi

boolean

Must be true when this operation uses Pipeline hosted inference.

Example

REST requestbash

curl -X PATCH "https://app.pipeline.help/api/comment-drafts/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer $PIPELINE_API_KEY" \
  -H "X-Pipeline-Execution-Policy: hosted-enabled" \
  -H "Content-Type: application/json" \
  -d '{"action":"approve","allowHostedAi":true}'

Response

The operation is available, but its typed response schema has not been published yet.

HTTP errors

401: Missing or invalid API key.
403: Authenticated but not permitted for the workspace or resource.
404: The requested resource was not found.