Hey.Café Endpoint Docs

Post Cafe

Docs Home / Post Cafe
Requires TokenAgecheckCache Purge

post_cafe_create

This call creates a new café.

Primary URL: https://endpoint.hey.cafe/post_cafe_create
textRequired
alias
The alias for the new café, this is used for mention tags and also the url.
textRequired
name
The name for the new café that will be used.
Requires TokenAgecheckCache Purge

post_cafe_delete

This call deletes a café.

Primary URL: https://endpoint.hey.cafe/post_cafe_delete
textRequired
cafe
The ID of the café to delete. It must have no other admins.
Requires TokenAgecheckCache Purge

post_cafe_join

This call makes the account join a café. Our limit is an account can only join up to 1000 cafés, no more. Once done the account may require to be approved, if this is the case the `response_data` will be `wait`.

Primary URL: https://endpoint.hey.cafe/post_cafe_join
textRequired
cafe
The ID of the café you want to join.
Requires TokenAgecheckCache Purge

post_cafe_favourite

Mark a café you are in as one of your favourites.

Primary URL: https://endpoint.hey.cafe/post_cafe_favourite
textRequired
cafe
The ID of the café you want to favourite.
Requires TokenAgecheckCache Purge

post_cafe_unfavourite

Remove a café you are in as one of your favourites.

Primary URL: https://endpoint.hey.cafe/post_cafe_unfavourite
textRequired
cafe
The ID of the café you want to unfavourite.
Requires TokenAgecheckCache Purge

post_cafe_update_notifications

Updates the personal setting for the account if it will get notifications for @everyone tags in a café.

Primary URL: https://endpoint.hey.cafe/post_cafe_update_notifications
textRequired
cafe
The café alias, or id.
textRequired
mode
The mode for the setting change, the values are on or off.
Requires TokenAgecheckCache Purge

post_cafe_update_welcome

Updates the welcome message that shows at the top of a café when you are a member.

Primary URL: https://endpoint.hey.cafe/post_cafe_update_welcome
textRequired
cafe
The café alias, or id.
textRequired
content
The content for the box. Send empty to remove.
Requires TokenAgecheckCache Purge

post_cafe_update_rules

Updates the rules page content that shows on the café.

Primary URL: https://endpoint.hey.cafe/post_cafe_update_rules
textRequired
cafe
The café alias, or id.
textRequired
content
The content listing the rules. Send empty to remove.
Requires TokenAgecheckCache Purge

post_cafe_update_website

Updates the website link that will show on the café.

Primary URL: https://endpoint.hey.cafe/post_cafe_update_website
textRequired
cafe
The café alias, or id.
textRequired
website
The website url. Send empty to remove.
Requires TokenAgecheckCache Purge

post_cafe_update_view

Updates the view style setting for the café.

Primary URL: https://endpoint.hey.cafe/post_cafe_update_view
textRequired
cafe
The café alias, or id.
textRequired
view
The only options are normal and forum. Normal is default.
Requires TokenAgecheckCache Purge

post_cafe_update_rule_require_tag

Updates the require_tag setting for the café.

Primary URL: https://endpoint.hey.cafe/post_cafe_update_rule_require_tag
textRequired
cafe
The café alias, or id.
textRequired
mode
The only options are on, or off. Off is default.
Requires TokenAgecheckCache Purge

post_cafe_update_member_admin

Makes or removes admin status from an account in the café.

Primary URL: https://endpoint.hey.cafe/post_cafe_update_member_admin
textRequired
cafe
The café alias, or id.
textRequired
mode
The only options are on, or off.
textRequired
member
The account alias, or id.
Requires TokenAgecheckCache Purge

post_cafe_update_member_moderator

Makes or removes moderator status from an account in the café.

Primary URL: https://endpoint.hey.cafe/post_cafe_update_member_moderator
textRequired
cafe
The café alias, or id.
textRequired
mode
The only options are on, or off.
textRequired
member
The account alias, or id.
Requires TokenAgecheckCache Purge

post_cafe_update_member_status

Can set if an account is active, banned, or removed from a café.

Primary URL: https://endpoint.hey.cafe/post_cafe_update_member_status
textRequired
cafe
The café alias, or id.
textRequired
mode
The only options are on, or off.
textRequired
member
The account alias, or id.
Requires TokenAgecheckCache Purge

post_cafe_report_open

Open all reports for a content type and let the reporter know we are looking into it, also makes you the investigator.

Primary URL: https://endpoint.hey.cafe/post_cafe_report_open
textRequired
resource_cafe
The ID of the café.
textRequired
resource_type
The resource type like account, cafe, conversation, or comment.
textRequired
resource_id
The resource id.
Requires TokenAgecheckCache Purge

post_staff_report_open

Close all reports for a content type and let the reporter know the results.

Primary URL: https://endpoint.hey.cafe/post_staff_report_open
textRequired
resource_cafe
The ID of the café.
textRequired
resource_type
The resource type like account, cafe, conversation, or comment.
textRequired
resource_id
The resource id.
textRequired
resource_valid
true or false text if the report is valid or not, this will change what we tell the user.