The Fluid Company APIs provide a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. These APIs use Company API tokens for authentication and provide full access to manage your company's resources including users, orders, products, media, and more.
For APIs that authenticate with User tokens, see the Rep APIs documentation. For public SDK APIs, see the Public SDK APIs documentation.
curl -i -X GET \ https://fluid-commerce.redocly.app/_mock/docs/apis/company.api/api/company/custom_catch_ups \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "catch_ups": [ { … } ], "meta": { "request_id": "string", "timestamp": "string" } }
curl -i -X POST \ https://fluid-commerce.redocly.app/_mock/docs/apis/company.api/api/company/custom_catch_ups \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "affiliate_id": 0, "title": "string", "description": "string", "type": "string", "contact_id": 0, "actions": {} }'
{ "catch_up": { "id": 0, "company_id": 0, "user_company_id": 0, "suggestion_title": "string", "suggestion_description": "string", "catch_up_class": "string", "catch_up_actions": [], "created_at": "string", "updated_at": "string" }, "meta": { "request_id": "string", "timestamp": "2019-08-24T14:15:22Z" } }
curl -i -X PATCH \ 'https://fluid-commerce.redocly.app/_mock/docs/apis/company.api/api/company/custom_catch_ups/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "suggestion_title": "string", "suggestion_description": "string" }'
{ "catch_up": { "id": 0, "company_id": 0, "user_company_id": 0, "suggestion_title": "string", "suggestion_description": "string", "catch_up_class": "CUSTOM_CATCH_UP", "catch_up_actions": [], "created_at": "string", "updated_at": "string" }, "meta": { "request_id": "string", "timestamp": "string" } }
curl -i -X DELETE \ 'https://fluid-commerce.redocly.app/_mock/docs/apis/company.api/api/company/custom_catch_ups/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "catch_up": { "id": 0 }, "meta": { "request_id": "string", "timestamp": "2019-08-24T14:15:22Z" } }
Custom Catchups can be created in two main ways:
Informative Catchup: This is the most common type of custom catchup. For instance, if the back office needs to share information with a user, they can use this API to create a catchup. An optional link can be included for further follow-up.
Action-Based Catchup: This type of custom catchup allows you to add an existing catchup action. For example, you might create a catchup for an affiliate to notify them about specific behavior from one of their contacts. This behavior might not be covered by our existing 26 catchup matrix.
Types of CatchUp Action Supported For Custom CatchUp
Specific contact assigned to an affiliate should be provided to use the SendSmsCatchUpAction and ToDoCatchUpAction.
curl -i -X POST \ https://fluid-commerce.redocly.app/_mock/docs/apis/company.api/api/company/catch_up/custom_catch_ups \ -H 'Content-Type: application/json' \ -d '{ "type": "custom_catch_up", "title": "Update Your Bank Details", "description": "Your credit card is going to expire on 24th December. Please update your details.", "affiliate_id": 1, "actions": { "type": "LinkRedirectionCatchUpAction", "data": { "button_text": "View Back Office", "redirect_to": "https://fluid.app/back_office" } } }'
{ "status": "success" }
Social Media