Custom options in Fuse: Integrating with the API

Fuse allows your organisation to have custom profile fields in user profiles and to define the custom options in the dropdown of those custom fields. For example, you might have a custom field in user profiles to select a user’s role from a set of predefined options. When integrating with Fuse's RESTful API to populate user data, it is essential to use the associated ID of a custom option rather than its label. This page outlines how to properly send data to Fuse when updating or creating user profiles with custom profile field options.

An example of a custom profile field in a user’s profile:

Sending custom option data via the API

When updating a user profile with a custom option in it, you must specify the ID of the selected option in the profile field, not the text label.

Example:

The field might be called "Landing Page", with the following selectable options:

Text label	ID

Text label	ID
Fuse Internal	4630
Fuse Client	4631
Investor	4632
Fuse Partner	4635

In this case, to set the "Landing Page" field to "Fuse Internal”, you must specify the ID for that option, as shown here:

✅ Correct approach:

{

  "Landing Page": "4630"

}

❌ Incorrect approach:

Do not specify the text label for the field, as shown here:

{

  "Landing Page": "Fuse Internal"

}

Retrieving custom option IDs

Retrieving custom option IDs via the API

To retrieve the correct IDs for custom options using the API, you can use the API endpoint that retrieves available fields and their corresponding values. The specific endpoint varies depending on the Fuse environment and API version in use.

Example request for retrieving custom options:
This request returns a response with all the available custom options and their respective IDs.

GET /api/v4.4/custom_options?auth_token=<<auth_token>>

Example response:

  {
    "id": 1598,
    "label": "Landing Page",
    "required": false,
    "visible": true,
    "api_visible": false,
    "send_to_analytics": false,
    "options": [
      {
        "id": 4630,
        "value": "Fuse Internal"
      },
      {
        "id": 4631,
        "value": "Fuse Client"
      },
      {
        "id": 4632,
        "value": "Investor"
      },
      {
        "id": 4635,
        "value": "Fuse Partner"
      }
    ]
  },
  {
    "id": 1606,
    "label": "Location",
    "required": false,
    "visible": true,
    "api_visible": false,
    "send_to_analytics": false,
    "options": [
      {
        "id": 4697,
        "value": "India"
      },
      {
        "id": 4698,
        "value": "London"
      },
      {
        "id": 4699,
        "value": "Singapore"
      },
      {
        "id": 4700,
        "value": "South Africa"
      },
      {
        "id": 4701,
        "value": "USA"
      }
    ]
  },

Retrieving custom option IDs via the Fuse UI

You can see the ID for each option in a custom profile field by going to the Profile custom optionsscreen in the Admin Panel and opening one of the custom profile fields. You will see the ID on the right-hand side of each option.

Best practices

Always retrieve the latest IDs before sending an API request, to ensure they are up-to-date.
Do not hardcode text values, as IDs may change over time.
Handle API responses dynamically, ensuring that if an ID is not found, the integration gracefully handles errors.
Validate input values before sending data to prevent mismatches between expected and received values.

By following these guidelines, integrations can reliably populate user profiles with the correct custom options in Fuse.