Post a Comment on a Campaign Plan
Posts a Comment on a Campaign Plan, or a reply in one of its threads. A Comment is a post on an AdCrunch Campaign Plan, by a person or by an agent for a person: an update, a question, or a decision. It is not a comment on a campaign at Meta, Google or TikTok.
A Comment does not change the Campaign Plan: its revision stays, and an approved plan stays approved.
/context/campaign-plans/{slug}/commentsAuthorizationBearer token · headerrequiredSend 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.
slugstringrequiredapplication/jsonbodystringrequiredThe markdown text, 1 to 10,000 characters.
parent_idstringThe top-level Comment that this one answers, cmt_…. Omit it to start a new thread. A reply cannot have replies.
The Comment, as the list shows it.
bodystring | nullrequiredThe markdown text, 1 to 10,000 characters. null for a deleted Comment that stays as the head of its thread.
clientIdstring | nullrequiredThe OAuth client of the agent that posted the Comment, or null when a person posted it. A Comment posted over this API has null.
createdAtnumberrequiredMilliseconds since the Unix epoch, UTC.
createdBystringrequiredThe author of the Comment, usr_…: the person who posted it, or for whom an agent posted it.
deletedbooleanrequiredtrue for a deleted Comment that a live reply still answers. Its body is null.
editedAtnumber | nullrequiredWhen the author last edited the text, or null.
idstringrequiredThe id of the Comment, cmt_….
parentIdstring | nullrequiredThe top-level Comment that this reply answers, or null for a top-level Comment.
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[]requiredOne entry for each field that does not match.
Show propertiesHide properties
objectinstringrequiredThe part of the request that holds the field.
bodycookieheadersparamsquerymessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
pathstringrequiredA JSON Pointer into that part of the request, such as /filename. An empty string is the whole part.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
invalid_requestmessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
No API key, or one that does not resolve. See the security scheme. error is unauthorized.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
unauthorizedmessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
The organization has no active subscription. An owner subscribes at paywallUrl. error is organization_unentitled.
paywallUrlstring<uri>requiredThe page where an owner of the organization subscribes. Show it to the person.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
organization_unentitledmessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
The caller does not hold campaign_plan:write. error is forbidden.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
forbiddenmessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
No Campaign Plan with that slug. error is not_found.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
messagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
error is parent_not_found when no top-level Comment of this plan has the parent_id, or parent_is_reply when parent_id is a reply.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
messagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.