How to report a post using Flowbox's API

Prerequisites

Before you start, ensure you have the following:

• API key: Your unique API authentication key. If you don't have it yet, please contact your CSM and they'll provide it to you.

• Flow key: The unique key identifying the Flow in which the post to be reported is in. The easiest way to find this is copying it from the "Copy Flow Key" option in the three dot menu, in the Flows section in Flowbox:

• Post key: The key of the post you want to report. This can be copied from the Post modal in its three-dot menu, or can be retrieved via the flow/{flowkey}/posts endpoint. Important: The same post has a different key per distributed instance. Make sure the post key provided matches the flow key.

API Endpoint

To retrieve the list of flows in your Flowbox account, you need to send a POST request to the following endpoint:

https://external-api.getflowbox.com/v2/flow/{flowKey}/report-post/{postKey}

You can find more information and make test calls in our Swaggerhub page.

Required Parameters

Example API Request

Here is an example request:

curl -X 'POST' \  
'https://external-api.getflowbox.com/v2/flow/FLOW_KEY_HERE/report-post/POST_KEY_HERE' \
  -H 'accept: application/json' \
  -H 'api-key: API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
  "message": "I do not like this image",
  "email": "REPORTER_EMAIL_HERE"
}'

Response:

The response will be a simple status code and message.

JSON returned: