Hey.Café Endpoint Docs

Post Comment Hide

Docs Home / Post Comment / Post Comment Hide
Requires TokenAgecheckCache Purge

post_comment_hide

Hide a comment, only works if done by staff in a café.

Primary URL: https://endpoint.hey.cafe/post_comment_hide

Variables

A list of variables needed to make the call work, they can be provided via the URL or POST.

textRequired
comment
The ID of the comment.

Error Codes

A list of error codes this call can return and what that it means.

not_found
We are unable to find this comment.
not_cafe_staff
You are not a member of the café staff so can not hide this comment.
already_done
The comment is already hidden.
needs_session
You are not using a valid session.

Response Modifications

We have a few URL options you can provide to modify the API response. If you have any suggestions let us know.

&convert_numeric=VARIABLE

This option will turn an array into a numeric response instead of KEYs when provided with the variable to modify. It will only work on main level variables at this time for example in the call endpoint.hey.cafe/api/account_conversations?query=anthony&convert_numeric=conversations.

&error_boolean=true

Return all responses in system_api_error as a boolean true or false only. If there is an error message when this is active it will be provided in system_api_error_message.

&error_no_http=true

Do not modify the HTTP response code when any error response happens, keep the HTTP response code as 200.

Flags

Some requests have rules that must be followed, they are done on the API end and will be automatically validated and if failed you will get an error message.

Needs Session

On fail will return needs_session and if this falg is set the request will only respond if made by a valid user session or API session.

Needs Agecheck

On fail you will get the response of needs_agecheck and this happens if request is made from an IP in a country or region that has an age verification law. To use this the IP must not be based in an age check region or the user must do the age verification in settings first.