This article explains how administrators can create and configure an API Profile to allow external systems to send application data into Logixx CRM securely and consistently.

Location

Admin > Marketing > API Profiles > Add new

General Tab Overview

The General tab controls the core behavior of the API Profile, including:

Whether the profile is active
Which data source is associated
How applications are created or updated

Basic identification and documentation of the integration

Field and Setting Descriptions

Active

Toggle control
Determines whether the API Profile can receive API requests

Enabled (ON):

The profile accepts incoming API requests

Disabled (OFF):

All API requests using this profile are rejected

✅ Recommended to disable profiles that are no longer in use.

Data Source (Required)

Dropdown selection
Defines the origin of the incoming application data

Used for:

Reporting
Lead source tracking
Workflow and automation logic

This field is required when the API is allowed to create new applications.

Name (Required)

Internal name for the API Profile
Used by administrators only

Code (Required)

Short, human-readable identifier
Used by external systems when posting data
Must be unique

Important:

This code is commonly shared with integration partners
It identifies which API Profile processes the request

Only Phone Required

Toggle control
When enabled:
- The system allows application creation with only a phone number
When disabled:
- Standard required fields apply

✅ Useful for early-stage lead capture or minimal data sources.

Add new app if the provided App# or ALV ID does not exist

Toggle control
Controls whether the API can create new applications

Enabled:

Creates a new application if no matching App# or ALV ID is found

Disabled:

Only updates existing applications
Prevents unintended app creation

✅ Recommended for update-only or sync integrations.

Description

Free-text field
Used for internal documentation

Saving the API Profile

Click Save to apply changes
Click Cancel to discard changes

Once saved:

The API Profile becomes available in the list
API posting instructions and field mappings can be configured
The profile can immediately accept requests if set to Active

Pipeline Status transition Tab

The Pipeline Status Transition tab defines:

Which pipeline status an application should be placed into
When the transition occurs
Whether the transition applies to new applications, existing applications, or both

This ensures that applications submitted via API enter the correct workflow automatically

Important System Note:

Status transition configurations are only applicable when using API to update an existing application.

This means:

❌ Status transitions do not apply when the API creates a new application
✅ Status transitions apply only when an existing App# or ALV ID is matched

If the API request creates a new application, this tab is ignored.

Column Descriptions

Code

Text field
Used as an internal identifier for the transition rule

Behavior:

If left incomplete, the system displays:
Unfinished – this line will not be stored
The rule will not be saved until completed correctly

✅ Always complete this field before saving.

Pipeline Status

Dropdown selection
Defines the target status the application will move to

Only active pipeline statuses are available for selection.

Enabled

Toggle control