Skip to main content

API Profiles

Overview

API Profiles allow external systems to securely send application data into Logixx CRM. Each API Profile defines how incoming data is accepted, validated, and mapped to application fields inside the CRM.

Location: Admin > Marketing > API Profiles

This feature is commonly used for integrations with:

  • Marketing platforms

  • Lead providers

  • Partner systems

  • Internal tools posting applications via API

With API Profiles, administrators can control data source behavior, required fields, and update rules—all without custom development.

What Is an API Profile?

An API Profile is a configuration that:

  • Identifies an external data source

  • Generates a unique API key or code

  • Defines validation rules for incoming requests

  • Maps API fields to CRM application fields

  • Controls how new or existing applications are created or updated

Each profile works independently and can be enabled or disabled at any time.

API Profile List

The left panel displays a table of all API Profiles configured in the system and it´s organized in the follwing columns:

Data Source

  • Displays the name of the external system or integration

  • Used for reporting and source tracking

Status

  • Shown as a green “Active” or red "Inactive" indicator

  • Indicates whether the profile can currently receive API requests

  • Inactive profiles reject incoming requests

Key

  • Unique identifier generated by the system

  • Used to authenticate API requests

  • Required in every API post

🔐 This key links incoming data to the correct API Profile.

Name

  • Internal name for the API Profile

  • Helps admins distinguish between similar integrations

Code

  • Short, human-readable identifier

  • Often used in documentation or shared with integration partners

Bypass Empty Value

  • Toggle control

  • When enabled:

    • Empty fields in the API request do not overwrite existing data

  • When disabled:

    • Empty values can replace existing values

✅ Recommended for update-only integrations.

Add the app if the App# or ALV ID doesn’t exist

  • Toggle control

  • When enabled:

    • Creates a new application if no match is found

  • When disabled:

    • Only updates existing applications

This prevents unintended app creation.

Description

  • Free-text explanation of the API Profile’s purpose

  • Useful for documenting:

    • Business logic

    • Partner details

    • Language, campaign, or workflow triggers

Actions (⋯)

  • Opens additional options such as:

    • Edit

    • Deactivate/Activate

    • Delete

Page Controls

  • Filter – Narrow profiles by criteria

  • Add New – Create a new API Profile

API Posting Instructions

When an API Profile is selected, the right panel displays real-time technical instructions for posting data using that profile.

Request URL

Displays the endpoint used for posting data:

POST https://apipost-bds.logixx.io/api/cgi/post/

The request must include the API Profile Code or Key.

Body Mapping Table

This table defines exactly how incoming API fields map to CRM fields.

Table Columns Explained

Key

  • Field name expected in the API request payload

  • Example:

    • first_name

    • external_ref

    • app_no

Target

  • CRM section where the data will be stored

  • Examples:

    • App General

    • App Primary Applicant

Field Name

  • Exact field name inside the CRM

  • Matches application profile fields

Note

  • Additional rules or validation notes

  • Indicates:

    • Required fields

    • Conditional requirements

    • Accepted values

    • Special behaviors

Required Fields (Visual Indicators)

  • Required fields are clearly marked in red

  • If any required field is missing:

    • The API request fails

    • No application is created or updated

Examples of required rules:

  • First Name and Last Name

  • At least one phone number (cell, home, or work)

Related Articles
Admin > API Post History
Monevo Integration in Logixx CRM
How to configure API Profiles?
API Profiles – Filter Panel Explained
API's: User creation & deactivation/Activation
Did this answer your question?