API Reference

We do support different types of custom fields in the CRM.

When adding or updating a contact over the API you can send a value for any custom field that exists in the CRM.

The provided data needs to be in compliance with the allowed data per custom field type.

For start you need to include a proper Custom Field Name. You can get the proper field name:

Manually

By navigating to: CRM -> Custom Fields


Over an API Call

📘

Method: List Custom Fields

The name of the field fetched over an API call is generated based on the below structure:

cf_{alias}_{field_id}

cf_ - Fixed part

alias - Custom Field Alias

field_id - Custom Field ID

Custom Field Types

The following field types exist within our CRM.

Single-line text

This is a field that accepts text as value.

Example value: This is a sample text.

Multi-line text

This is a field that accepts text as value with representation in multiple lines.

Example value: This is a sample text\n
in multiple lines.

Number

This is a field that accepts number as value.

Example value: 13483372

Dropdown select

This is a field that accepts one of the select field available options (internal value).

Example value: option_1

Dropdown multi-select

This is a field that accepts one or multiple (separated by comma) values of the select field available options (internal value).

Example value: option_1,option_2

Date-time picker

This is a field that accepts a valid Date-Time value based on the created Custom Field date format and time options.

Example value: 08/02/2023

Radio select

This is a field that accepts one of the radio field available options (internal value).

Example value: radio_1

Checkbox select

This is a field that accepts one or multiple (separated by comma) values of the checkbox field available options (internal value).

Example value: checkbox_1,checkbox_2

Url

This is a field that accepts a valid URL value.

Example value: https://www.google.com

Email

This is a field that accepts a valid email value.

Example value: john.smith@gmail.com

Phone

This is a field that accepts a valid phone number value.

Example value: +13023088572

Platform.ly user

This is a field that accepts a Platformly User First Name.

Example value: John