Activate the API Gateway
Pixie CRM guidance. Follow the route for your workspace, check your role and enabled modules, and verify the result before moving on.
Follow this guide to run install.php and verify module tables and Utilities/Tools child menu.
Where to goAdmin Area → Setup → Modules → Proplix API Gateway → Activate
Before you start
- Verify the module is active and use the exact navigation shown above.
- Use an account with the stated module and core CRM permissions.
- Use known test records when changing statuses, visibility, saved filters or global navigation.
What this guide helps you do
Run install.php and verify module tables and Utilities/Tools child menu. The instructions below follow the supplied module’s live menu, controller, form, model and JavaScript flow.
Follow these steps
- Go to Admin Area → Setup → Modules → Proplix API Gateway → Activate.
- Find the record, endpoint, field or action used to activate the api gateway.
- Complete the displayed values exactly as described in this guide.
- Select the available save, submit, send, upload, create, update or confirm action.
- Return to the related register, portal, activity log or API response and verify the expected result.
Fields and options
Workspace or endpointAdmin Area → Setup → Modules → Proplix API Gateway → Activate
PurposeRun install.php and verify module tables and Utilities/Tools child menu.
Rules and limits
- The action is available only where the supplied module exposes it and the signed-in user or API client meets the stated access conditions.
- Internal helpers are documented under the visible workflow or endpoint they support rather than presented as invented menu pages.
Check it worked
- The activate the api gateway workflow completes without a validation, permission, ownership or availability error.
- The related record, portal view, activity entry, notification log or API response shows the expected state.
- Client-visible, public and API data remains limited to the code-backed ownership and visibility rules.
Security, privacy and operational checks
- Use controlled test records and non-production credentials before wider rollout.
- Grant least privilege and protect secure links, personal data, uploaded files, signatures, API tokens, allowed origins and server IPs.
Related guides
Was this guide useful?Your response is stored only in this browser.