Skip to content

Delete Comment Automation API

The Delete Comment Automation API removes a comment automation by its identifier. Use the exact DELETE method with the path /v1/comment-automations/{id}, supply the required id path parameter, and authenticate with the x-access-key header. This page documents the input contract, a worked request, and the documented JSON responses so you can call the operation and handle failures predictably.

Delete Comment Automation API — operation summary

Delete Comment Automation removes a single comment automation identified by the id path parameter. The operation uses the DELETE method and the exact path /v1/comment-automations/{id}. There is no documented request body for this operation, so the identifier and authorization header carry the request. Before calling it, confirm that the id you intend to delete is the correct automation, because the documented contract does not describe undo, restore, or cascade behavior.

Authorization — x-access-key header

Every request must include the x-access-key header with a token value. The header name is exactly x-access-key and the value format shown in the contract is <token>. Treat the token as a secret: keep it in server-side configuration or an environment variable rather than in client-side code, logs, or version-controlled files. If a request is rejected for authorization reasons, verify that the header name is spelled exactly, that no extra whitespace is included, and that the token value is complete before changing anything else.

Path Parameters — id

The path parameter id is a required string. Replace the {id} segment in /v1/comment-automations/{id} with the identifier of the comment automation to delete, and make sure the value is URL-safe if it contains characters that need encoding. A missing or incorrect id is the most likely cause of a 400 or 404 response, so validate the identifier against your own records before issuing the request. Do not add query parameters or a request body, because neither is part of the documented input contract.

Worked request example

The worked example in Delete a comment automation with cURL shows the exact DELETE request with the x-access-key header added. Run the request only with a real token and a real id in an environment where deletion is intended, because the call is meant to remove the automation. After sending the request, check the HTTP status code before parsing the body: a 200 response indicates the documented success shape, while 400, 403, and 404 responses use the error shape with a required message field.

Response Body — status and JSON contract overview

For a 200 application/json response, the body contains success as an optional boolean, shown in the example as true. For 400, 403, and 404 application/json responses, the body contains success as a required boolean and message as a required string. Parse the body as JSON only after confirming the content type, and treat success and message as the documented fields rather than expecting additional undocumented fields. Keep the raw status code and body in your logs when debugging, because the message text is the only documented diagnostic for errors.

200 — success response shape

When the delete succeeds, the service returns 200 application/json with a body containing success as an optional boolean. In code, check the status code first and then read success if present. Do not treat the absence of a message field in a 200 response as an error, because message is documented only for the error responses.

400 — bad request response shape

A 400 application/json response indicates a bad request. The body contains success as a required boolean and message as a required string. When you receive this status, re-check the request method, the exact path, the required id value, and the x-access-key header before retrying. Do not assume a specific message value, because the contract documents the field and its type rather than enumerating message strings.

403 — forbidden response shape

A 403 application/json response indicates a forbidden request. The body contains success as a required boolean and message as a required string. When you receive this status, verify that the x-access-key header is present and correct, and confirm that the token is allowed to perform this operation. Repeating the same request without correcting authorization is unlikely to change the outcome.

404 — not found response shape

A 404 application/json response indicates that the requested resource was not found. The body contains success as a required boolean and message as a required string. When you receive this status, confirm that the id in the path matches an existing comment automation and that the identifier has not already been deleted. Because the contract does not document idempotency for repeated deletes, do not assume that sending the same DELETE again will produce a 200 response.

Failure-handling checklist

Use this checklist whenever a delete call fails. First, confirm the method is DELETE and the path matches /v1/comment-automations/{id} exactly, including case. Second, confirm the id path parameter is present and is the intended required string value. Third, confirm the x-access-key header is present with a complete token. Fourth, branch on the status code: for 400, fix the request; for 403, fix authorization; for 404, fix the identifier. Finally, log the status code and the message field for diagnosis without inventing error codes or retry rules that are not documented.

Input contract
FieldLocationRequiredTypeValue or notes
idPath parameterRequiredstringIdentifier of the comment automation to delete; replaces {id} in the path.
x-access-keyHeaderRequiredstring<token>

Exact documented input contract for DELETE /v1/comment-automations/{id}.

Response and status matrix
StatusContent typesuccessmessage
200application/jsonOptional booleanNot documented
400application/jsonRequired booleanRequired string
403application/jsonRequired booleanRequired string
404application/jsonRequired booleanRequired string

Exact documented response shapes; success is optional boolean for 200 and required boolean for errors, message is required string for errors.

Frequently asked questions

What request deletes a comment automation?

Send a DELETE request to /v1/comment-automations/{id}, replacing {id} with the required string identifier for the comment automation to delete, and include the x-access-key header with your token.

What JSON fields are returned for success and error responses?

A 200 application/json response contains success as an optional boolean. The 400, 403, and 404 application/json responses contain success as a required boolean and message as a required string.

How should I handle a failed delete request?

Check the status code first. For 400, 403, or 404, read the required message field and verify the request, authorization, and identifier before retrying. Do not assume an error message value or retry rule that is not documented.

Delete a comment automation with cURL
curl -X DELETE "{{API_BASE_URL}}/v1/comment-automations/string" -H "x-access-key: <token>"
Interface fields
ScopeFieldTypeType referenceRequiredDescription
id#1idstring__0Yes
response#2responseobject__0
response#2response.successboolean__1No
response#3responseobject__0
response#3response.successboolean__1Yes
response#3response.messagestring__2Yes