---
title: "Update a comment automation"
method: PATCH
path: "/comment-automations/{id}"
tags: ["Comment automations"]
---

# Update a comment automation

`PATCH /comment-automations/{id}`

## Request

- Base URL: `https://api.rizamo.com/v1`
- URL: `https://api.rizamo.com/v1/comment-automations/{id}`
- Auth: HTTP bearer

The account and post cannot change. Pausing stops it at once; comments made while it is paused are never answered. Resuming starts from then.

## Path parameters

- `id` string, required: The comment automation's id (`cauto_`).

## Request body

- object
  - `name` string: For people: "Guide on the October reel".
  - `keywords` string[]: Any of them triggers it, in any case and with or without accents. Empty: every comment.
  - `match` 'contains' | 'word' | 'exact': contains: the keyword anywhere, even inside a longer word. word (the default): as a whole word or phrase. exact: the whole comment is the keyword, give or take punctuation and spaces. Always in any case and with or without accents.
  - `exclude` string[]: A comment with any of these, as whole words, never triggers it.
  - `message` object: The private reply: its text, and the link behind a button.
    - `text` string, required: With a link, up to 640 characters, above the button. Without, up to 1,000 bytes: Meta counts bytes, and accents and emoji take 2 to 4. Every web address in it becomes a Rizamo link that counts clicks, and counts as one (38 characters).
    - `link` string, uri, nullable, required: Behind a button under the text, as a Rizamo link that counts clicks. Null for none: the message is the text alone.
    - `button` string: The button's title, up to 20 characters, such as "Get the guide". Left out: Open link on a new automation, the title it had on an update. Shown only with a link.
  - `publicReplies` string[]: Up to 5. After the private reply goes out, one is posted under the comment, picked at random, so the replies do not all read the same.
  - `markDone` boolean: Mark the comment's thread done once the private reply went out.
  - `followGate` object, nullable: Instagram only. The private reply asks them to follow and reply, with a button that replies for them; their reply gets the message if they follow, or the reminder once.
    - `ask` string, required: The first private reply, sent instead of the message, above the button: ask them to follow and reply, such as "Follow us, then tap below or reply LINK to get it". Up to 640 characters, sent as written.
    - `reminder` string, required: Sent once, above the button, when they reply without following. The next reply is checked again. Up to 640 characters, sent as written.
    - `button` string: The button under the ask and the reminder, up to 20 characters: tapping it sends its title as their reply, and any reply opens the gate. Left out: I'm following on a new automation, the title it had on an update.
  - `oncePerPerson` boolean: One message per person for this automation, however many times they comment.
  - `utm` object, nullable: UTM tags, each up to 100 characters, trimmed and URL-encoded. An empty one adds nothing.
    - `source` string: `utm_source`: where visitors come from, such as instagram.
    - `medium` string: `utm_medium`: the kind of traffic, such as social.
    - `campaign` string: `utm_campaign`: the campaign, such as autumn-menu.
    - `term` string: `utm_term`: a keyword, mostly for paid search.
    - `content` string: `utm_content`: tells apart links of one campaign.
  - `status` 'active' | 'paused': paused stops it at once: comments made while it is paused are never answered. active resumes it from then.

## Response `200`

OK

- CommentAutomation
  - `id` string, required
  - `profileId` string, required
  - `accountId` string, required
  - `network` 'instagram' | 'facebook' | 'threads' | 'linkedin' | 'tiktok' | 'youtube' | 'x' | 'pinterest' | 'google', required
  - `name` string, required
  - `status` 'active' | 'paused', required: Paused: comments are not answered, and those that arrive meanwhile never will be.
  - `pausedReason` string, nullable, required: Why Rizamo paused it, such as a permission Meta refused or a link of the message that stopped working: fix it, then resume. Null when it is active or someone paused it.
  - `networkPostId` string, nullable, required: Only comments on this post on the network (`List posts on the networks`). Null with `postId` null: every post of the account, new ones too.
  - `postId` string, nullable, required: Only comments on this Rizamo post, on the account: it can be scheduled, and the automation starts when it goes live there.
  - `armed` boolean, required: False while its Rizamo post is not live on the account yet.
  - `keywords` string[], required: Any of them triggers it. Empty: every comment.
  - `match` 'contains' | 'word' | 'exact', required: contains: the keyword anywhere, even inside a longer word. word (the default): as a whole word or phrase. exact: the whole comment is the keyword, give or take punctuation and spaces. Always in any case and with or without accents.
  - `exclude` string[], required: A comment with any of these, as whole words, never triggers it.
  - `message` object, required
    - `text` string, required: With a link, up to 640 characters, above the button. Without, up to 1,000 bytes: Meta counts bytes, and accents and emoji take 2 to 4. Every web address in it becomes a Rizamo link that counts clicks, and counts as one (38 characters).
    - `link` string, uri, nullable, required: Behind a button under the text, as a Rizamo link that counts clicks. Null for none: the message is the text alone.
    - `button` string: The button's title, up to 20 characters, such as "Get the guide". Left out: Open link on a new automation, the title it had on an update. Shown only with a link.
  - `links` object[], required: The Rizamo links in the message, one per web address.
    - `url` string, required: The address as written in the message, without the UTM tags.
    - `shortUrl` string, required: What the message carries instead. The address itself until Rizamo counts clicks on it.
    - `linkId` string, nullable, required: The Rizamo link. Null while clicks are not counted.
  - `utm` object, nullable, required: UTM tags, each up to 100 characters, trimmed and URL-encoded. An empty one adds nothing.
    - `source` string: `utm_source`: where visitors come from, such as instagram.
    - `medium` string: `utm_medium`: the kind of traffic, such as social.
    - `campaign` string: `utm_campaign`: the campaign, such as autumn-menu.
    - `term` string: `utm_term`: a keyword, mostly for paid search.
    - `content` string: `utm_content`: tells apart links of one campaign.
  - `publicReplies` string[], required: After the private reply goes out, one of these is posted under the comment, picked at random. Empty: none.
  - `markDone` boolean, required: Marks the comment's thread done in the inbox once the private reply went out.
  - `followGate` object, nullable, required
    - `ask` string, required: The first private reply, sent instead of the message, above the button: ask them to follow and reply, such as "Follow us, then tap below or reply LINK to get it". Up to 640 characters, sent as written.
    - `reminder` string, required: Sent once, above the button, when they reply without following. The next reply is checked again. Up to 640 characters, sent as written.
    - `button` string: The button under the ask and the reminder, up to 20 characters: tapping it sends its title as their reply, and any reply opens the gate. Left out: I'm following on a new automation, the title it had on an update.
  - `oncePerPerson` boolean, required: One message per person for this automation, however many times they comment. On by default.
  - `stats` object, required
    - `triggered` integer, required: Comments that matched.
    - `sent` integer, required: People who got the message with the link.
    - `waiting` integer, required: Matched comments still on their way, and people the follow gate is waiting on.
    - `skipped` integer, required: Matched comments not answered: the person already got it, or the comment was too old.
    - `failed` integer, required
    - `expired` integer, required: People the follow gate waited on in vain: no reply within 7 days. triggered is sent, waiting, skipped, failed and expired added up.
    - `failures` object[], required: Skipped, failed and expired runs by reason, most first.
      - `reason` 'already_sent' | 'too_old' | 'refused' | 'unclear' | 'expired', required: already_sent: this person already got this automation's message, or may have (an unclear one). too_old: the comment was more than 7 days old when Rizamo got to it, past Meta's window. refused: Meta refused this message, such as a person who does not take messages, or a comment that already got its one private reply (another app or team with the account sent first), or would have: the comment was deleted before the message went out (skipped); the run's `error` says which. unclear: Rizamo could not tell whether it went out, so it never sends it again. expired: the follow gate got no reply within 7 days of its last message. A refused login or permission is no reason here: the automation is paused with it, and its runs wait as they were, to go out once it is resumed within the 7 days.
      - `count` integer, required
    - `linkClicks` integer, nullable, required: Clicks on the message's Rizamo links. Null while clicks are not counted.
    - `followGate` object, nullable, required: Null when the automation has no follow gate and never had runs with one.
      - `asked` integer, required: People asked to follow and reply.
      - `followed` integer, required: People who replied as followers and got the message: the conversions.
      - `reminded` integer, required: People who replied without following and got the reminder.
      - `expired` integer, required
    - `sentToday` integer, required: Messages the account sent through automations in the last 24 hours, against the daily cap.
    - `dailyCap` integer, required: Messages an account sends through automations in 24 hours at most; more wait for room, within Meta's 7 days.
  - `createdBy` union, required
    - object
      - `type` 'agent', required
      - `agent` 'claude' | 'chatgpt' | 'claudecode' | 'cursor' | 'codex' | 'gemini' | 'perplexity' | 'openclaw' | 'n8n' | 'make' | 'zapier', nullable, required
      - `name` string, required
      - `agentId` string
      - `onBehalfOf` object: The person whose agent it is, who connected it and whom it acts as, with their role: "Ana via Claude Code". Events from before 2026-11-02 have it too, with the person's name now. Left out of an agent with no person, and of other records from before. After the person's erasure, `name` is "A former member" and `userId` empty.
        - `userId` string, required
        - `name` string, required
    - object
      - `type` 'user', required
      - `userId` string, required
      - `name` string, required
      - `initials` string, required
    - object
      - `type` 'api_key', required
      - `keyId` string, required
      - `name` string, required
    - object
      - `type` 'automation', required
      - `automationId` string, required
      - `name` string, required
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required

## Other responses

- `400`: `invalid_request`: A field is missing or wrong, or the request cannot be done as asked: the message names the field or says what to change.
- `401`: `unauthorized`: No API key or sign-in, or the key does not work: it was deleted, or it expired.
- `403`: `forbidden`: The caller may not do this: the key or agent lacks the scope (the message names it), or the action needs another role or a fresh sign-in.
- `404`: `not_found`: No such object, or it is outside your team or the profiles your key reaches.
- `409`: `conflict`: The object's state does not allow it now, such as an account that needs a new login. `queue_empty`: A post with `queue: true` whose profile has no posting times: set them, or give a `scheduledAt`. `queue_full`: No posting time free for the post's accounts in the next 90 days: add times, or give a `scheduledAt`. `idempotency_key_in_use`: A request with this `Idempotency-Key` is still running: try again in a moment.
- `413`: `payload_too_large`: The body is over 1 MB: files go up through the upload links of `POST /v1/media`.
- `415`: `unsupported_media_type`: The body is not JSON: send it with `Content-Type: application/json`.
- `429`: `rate_limited`: Over one of Rizamo's limits, or a network asked Rizamo to slow down: wait for `Retry-After` seconds, or as long as the message says.
- `500`: `internal`: Our side failed: retry, and send the `requestId` if it keeps failing.
- `503`: `timeout`: The request took too long to work out, most often a report: try again in a moment, or ask a report for a shorter period or one profile.

---

[API](https://skmtc.dev/rizamo/apis/rizamo-api.md) - [All operations](https://skmtc.dev/rizamo/apis/rizamo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/rizamo/apis/rizamo-api/revisions/31b0c1b1ffb5?raw)
