Edit a Comment of a Campaign Plan

Replaces the text of a Comment, and sets editedAt. Only the author of the Comment can edit it.

PATCH/context/campaign-plans/{slug}/comments/{comment_id}

Authorization

AuthorizationBearer token · headerrequired

Send Authorization: Bearer <credential>.

Use an API key (acr_…), from the AdCrunch console under Settings → API keys.

The credential names the organization, and no operation takes an organization parameter.

See https://docs.adcrunch.dev/api/authentication.

Path parameters

comment_idstringrequired

slugstringrequired

Request body

requiredapplication/json

bodystringrequired

The new markdown text, 1 to 10,000 characters.

min length 1 · max length 10000

Responses

200

The Comment with its new text.

bodystring | nullrequired

The markdown text, 1 to 10,000 characters. null for a deleted Comment that stays as the head of its thread.

clientIdstring | nullrequired

The OAuth client of the agent that posted the Comment, or null when a person posted it. A Comment posted over this API has null.

createdAtnumberrequired

Milliseconds since the Unix epoch, UTC.

createdBystringrequired

The author of the Comment, usr_…: the person who posted it, or for whom an agent posted it.

deletedbooleanrequired

true for a deleted Comment that a live reply still answers. Its body is null.

editedAtnumber | nullrequired

When the author last edited the text, or null.

idstringrequired

The id of the Comment, cmt_….

parentIdstring | nullrequired

The top-level Comment that this reply answers, or null for a top-level Comment.

400

The request does not match the schema of this operation: a field is missing or has the wrong type, or the body is not valid JSON. error is invalid_request, and issues names each field. Nothing was changed.

issuesobject[]required

One entry for each field that does not match.

Show properties

Array of object

instringrequired

The part of the request that holds the field.

Allowed:bodycookieheadersparamsquery

messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

pathstringrequired

A JSON Pointer into that part of the request, such as /filename. An empty string is the whole part.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:invalid_request

messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

401

No API key, or one that does not resolve. See the security scheme. error is unauthorized.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:unauthorized

messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

402

The organization has no active subscription. An owner subscribes at paywallUrl. error is organization_unentitled.

paywallUrlstring<uri>required

The page where an owner of the organization subscribes. Show it to the person.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:organization_unentitled

messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

403

Another person is the author of the Comment. error is not_author.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

404

No live Comment of this Campaign Plan has that id. error is not_found.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

Request

curl -X PATCH 'https://api.adcrunch.dev/context/campaign-plans/string/comments/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "body": "Meta carries the reach. TikTok tests the 18–24 audience first."
}'

const response = await fetch("https://api.adcrunch.dev/context/campaign-plans/string/comments/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"body\": \"Meta carries the reach. TikTok tests the 18–24 audience first.\"\n}"
});

import requests

response = requests.patch(
    "https://api.adcrunch.dev/context/campaign-plans/string/comments/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"body\": \"Meta carries the reach. TikTok tests the 18–24 audience first.\"\n}",
)

Response

{
  "body": "Meta carries the reach. TikTok tests the younger audience first.",
  "clientId": null,
  "createdAt": 1789610000000,
  "createdBy": "usr_5d2b71",
  "deleted": false,
  "editedAt": 1789613600000,
  "id": "cmt_8b3f10",
  "parentId": null
}

{
  "issues": [
    {
      "in": "body",
      "message": "string",
      "path": "string"
    }
  ],
  "error": "invalid_request",
  "message": "string"
}

{
  "error": "unauthorized",
  "message": "string"
}

{
  "paywallUrl": "http://example.com",
  "error": "organization_unentitled",
  "message": "string"
}

{
  "error": "string",
  "message": "string"
}

{
  "error": "string",
  "message": "string"
}