Delete a comment

DELETE/v1/api/store/{team_slug}/comment/{id}

v1Operation ID v1_public_comment_destroy

Deletes a comment. It is a soft delete: the comment is hidden from the order but kept, and PATCH /v1/api/store/{team_slug}/comment/{hash_id}/restore brings it back.

Permission

Any member of the team, for any comment on the team. It does not check who wrote the comment or whether you can see its order.

Side effects

• People with the order open see the comment disappear.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• idstringrequired

  The comment's id. A hash id; unique keys and document numbers are refused with 404.

  • Example JiDNJJ08el0QrD

Request body

This operation takes no request body.

Response

200Successful response.

• datanullrequired
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

  When

  No comment of this team has this id.

  Fix

  Use a comment id from the order's comment list.

Notes

• Deleting a comment that is already deleted succeeds again.

Related

• PATCHRestore a deleted comment/v1/api/store/{team_slug}/comment/{hash_id}/restore

Example request

curl

curl -X DELETE 'https://secure.yoprint.com/v1/api/store/your-team/comment/JiDNJJ08el0QrD' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": null,
  "status": 200,
  "success": true
}