The SugarCRM platform that you want to use during your session.

Data Type

string

Default Value

"base"

Remarks

In the SugarCRM API, a platform refers to a specific client application or integration that accesses the API. Examples include base, mobile, portal, or a custom platform name for a custom integration.

The value must be set to one of the labels listed in SugarCRM under User Menu > Admin > Developer Tools > Configure API Platforms. Any value that is not included in this list is rejected by SugarCRM.

Use this connection property if you are encountering a login conflict (error during authentication).

To create a new platform in SugarCRM:

1. Navigate to your Admin Dashboard.
2. Click your admin icon (located on the top-right of the site).
3. Click Admin.
4. In the "Developer Tools" section, click Configure API Platforms.
5. To add a new platform, enter the platform name, and click the Add button.
6. Click Save.