Skip to content
View as Markdown

GET Get Dynamic Segment Custom Fields​

GET
/dynamic-segments/custom-fields

Retrieve the available filter field definitions and default settings for building custom dynamic segment conditions. Returns field types, operators, and options for constructing segment filters. Requires FluentCampaign Pro.

Required capability: fcrm_manage_contact_cats

Enforced by DynamicSegmentPolicy::verifyRequest(), the policy default for this route group.

Requires: FluentCampaign Pro. Without it the route does not exist.

Authorizations​

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Responses​

Filter field definitions and default settings.

application/json
JSON
{
"fields": [
{
"type": "string",
"key": "string",
"heading": "string",
"label": "string",
"fields": {
"additionalProperties": {
"type": "string",
"label": "string",
"operators": {
},
"options": {
},
"value": "string",
"is_multiple": true,
"description": "string",
"inline_help": "string"
}
}
}
],
"settings_defaults": {
"conditions": [
{
"field": "string",
"operator": "string",
"value": "string"
}
],
"condition_match": "string",
"email_activities": {
"status": "string",
"last_email_open": {
"value": 0,
"operator": "string"
},
"last_email_link_click": {
"value": 0,
"operator": "string"
},
"last_email_activity_match": "string"
}
}
}

Playground​

Authorization

Samples​

Powered by VitePress OpenAPI