Hide a comment
POST/v1/agents/:agentId/comments/:commentId/hide
x-scope: "comments:write"
Hides the comment on Facebook or Instagram, as a teammate does on the Comments page. It
leaves public view but isn't deleted: on Facebook the commenter and their friends still
see it. moderation.hidden_by becomes user, or platform when Facebook had already
hidden it, and a hidden comment gets no reply. 422 comment_already_hidden when it is
hidden already; 422 platform_hide_failed when the platform refused or couldn't be
reached, for example because the comment was deleted; that one can be temporary, so try
again later. After a 500, a retry that answers comment_already_hidden means the
first one went through.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
- 500
- 503
The comment, hidden.
Response Headers
Correlation id for this request — paste into support tickets.
Authentication failed. Single code (invalid_api_key) covers every
sub-case: missing header, wrong scheme, malformed, unknown, revoked or
expired key. The message field disambiguates for humans debugging.
One exception: when the key could not be checked because of a server-side
fault, the status is still 401 but type is internal_error and code
is internal_server_error; retry with backoff.
Response Headers
Correlation id for this request — paste into support tickets.
Authenticated, but not allowed: insufficient_scope (the key lacks the scope in this
operation's x-scope) or agent_not_authorized (the key is limited to other agents).
Response Headers
Correlation id for this request — paste into support tickets.
not_found when the comment isn't on one of this agent's pages, including a page that
was disconnected or moved to another agent; agent_not_found when
the agent is not one of your company's agents. endpoint_not_found when an id in the
path isn't a UUID.
Response Headers
Correlation id for this request — paste into support tickets.
comment_already_hidden (hiding a comment that is hidden already),
comment_not_hidden (showing a comment that isn't hidden) or platform_hide_failed
(Facebook or Instagram refused or couldn't be reached, for example because the comment was
deleted; it can be temporary, so try again later). After a 500 on a hide or unhide, a
retry that answers comment_already_hidden or comment_not_hidden means the first one
went through.
Response Headers
Correlation id for this request — paste into support tickets.
Per-key rate limit hit. Default is 60/min/key; an endpoint with an
x-rate-limit-per-minute of its own counts in a budget of its own
(today listWhatsAppTemplates, which allows 10/min/key, and
sendConversationMessage, which allows 20/min/key), and its 429
reports that limit in X-RateLimit-Limit. Retry-After tells you when to retry;
X-RateLimit-Reset is the Unix timestamp of the next window.
Per-success-response
X-RateLimit-*headers are a known gap; on 2xx responses these headers are NOT currently emitted. Customers should rely on 429 +Retry-Afterfor backoff signals.
Response Headers
Correlation id for this request — paste into support tickets.
Seconds to wait before retrying.
The per-minute request limit of the endpoint called. Every key has the same limits today.
Remaining requests in the current window. 0 on rejection.
Unix timestamp at which the current window resets.
Unexpected server-side failure. Retry with exponential backoff. If
the failure persists, send us the correlation_id.
Response Headers
Correlation id for this request — paste into support tickets.
Mojeeb couldn't check access because of a temporary fault: the key's,
or on assignLead and assignConversation the teammate's. Nothing was
changed. Retry with backoff.
Response Headers
Correlation id for this request — paste into support tickets.