Capability

CLI command

MCP tool

fcrm list contacts

fluent-wp-cli fcrm-list-contacts

fcrm_list_contacts

fcrm update contact

fluent-wp-cli fcrm-update-contact

fcrm_update_contact

fcrm list campaigns

fluent-wp-cli fcrm-list-campaigns

fcrm_list_campaigns

fc list spaces

fluent-wp-cli fc-list-spaces

fc_list_spaces

fc create feed

fluent-wp-cli fc-create-feed

fc_create_feed

fc create comment

fluent-wp-cli fc-create-comment

fc_create_comment

ff list submissions

fluent-wp-cli ff-list-submissions

ff_list_submissions

ff form stats

fluent-wp-cli ff-form-stats

ff_form_stats

List configured sites

fluent-wp-cli list-accounts

list_accounts

Read one native Community member report

fluent-wp-cli fc-analytics-overview

fc_analytics_overview

Review exact ordered cross-plugin tasks

fluent-wp-cli preview-site-batch

preview_site_batch

Execute reviewed cross-plugin tasks

fluent-wp-cli submit-site-batch

submit_site_batch

Save bounded cross-plugin responses privately

fluent-wp-cli save-site-snapshot

save_site_snapshot

Number

Section

What it covers

1

What you can ask it

What you can ask it

2

Quick install

Quick install

3

Set up Fluent WordPress access

Set up Fluent WordPress access

4

Connect your client

Connect your client

5

Check it works

Check it works

6

Output, flags and exit codes

Output, flags and exit codes

7

MCP or CLI and token cost

MCP or CLI and token cost

8

Every tool and argument

Every tool and argument

9

CRM, Community and Forms workflows

CRM, Community and Forms workflows

10

Exact reviewed batches and snapshots

Exact reviewed batches and snapshots

11

Several private sites

Several private sites

12

Writing safely

Writing safely

13

How the two surfaces work

How the two surfaces work

14

Your data

Your data

15

Environment variables

Environment variables

16

Updates and removal

Updates and removal

17

Troubleshooting

Troubleshooting

18

API coverage and comparisons

API coverage and comparisons

19

Versions and migration

Versions and migration

20

FAQ

FAQ

Flag

Behavior

--agent

Compact JSON and no prompts; never confirms a write

--confirm

Explicit approval for exactly requested confirmed work

--account LABEL

Exact private site profile

--select a,b.c

Filter returned fields locally

--payload / --payload-file

Whole native body, exclusive with flat body flags/each other

--tasks JSON

Repeat one task object per flag

--review-sha256 HASH

Exact unchanged local preview hash

--output-file PATH

Exclusive new private snapshot file

Exit

Meaning

0

Native response/receipt returned; inspect status and downstream effects

1

Unexpected error

2

Usage, schema, a refused or unapproved operation, an unknown command or a hidden write

3

Not found

4

Authentication/permissions

5

API/network or unknown mutation outcome

7

Rate limited

10

Missing or invalid private configuration

Cost

2.0.1

3.0.0

Claude Code, every tool loaded, every message

26,470

25,728

Claude Code's default, tool search, every message

1,295

1,294

SKILL.md, read once

1,325

1,385

Codex over the CLI, one task, median of five

150,331

83,099

Codex over MCP, the same task, median of five

76,977

76,746

Argument

Required

Type

Details

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

filter_type

Optional; native body and guard rules still apply

string

Type of filtering to apply. enum: ["simple", "advanced"]. default: "simple".

search

Optional; native body and guard rules still apply

string

Search contacts by name, email, or other searchable fields.

sort_by

Optional; native body and guard rules still apply

string

Column to sort by. default: "id".

sort_type

Optional; native body and guard rules still apply

string

Sort direction. enum: ["ASC", "DESC"]. default: "DESC".

has_commerce

Optional; native body and guard rules still apply

string

Filter by commerce integration availability.

custom_fields

Optional; native body and guard rules still apply

string

Set to true to include custom field values in the response. enum: ["true", "false"].

tags

Optional; native body and guard rules still apply

array

Filter by tag IDs (simple filter mode only).

tags[]

Per item when supplied

integer

Array item schema.

statuses

Optional; native body and guard rules still apply

array

Filter by contact statuses (simple filter mode only).

statuses[]

Per item when supplied

string

Array item schema. Enum: ["subscribed", "pending", "unsubscribed", "bounced", "complained"]

sms_statuses

Optional; native body and guard rules still apply

array

Filter by SMS statuses (simple filter mode only).

sms_statuses[]

Per item when supplied

string

Array item schema. Enum: ["sms_subscribed", "sms_unsubscribed", "sms_pending", "sms_bounced"]

lists

Optional; native body and guard rules still apply

array

Filter by list IDs (simple filter mode only).

lists[]

Per item when supplied

integer

Array item schema.

company_ids

Optional; native body and guard rules still apply

array

Filter by company IDs.

company_ids[]

Per item when supplied

integer

Array item schema.

advanced_filters

Optional; native body and guard rules still apply

string

JSON-encoded advanced filter groups (advanced filter mode only).

per_page

Optional; native body and guard rules still apply

integer

Number of contacts per page. default: 15. minimum: 1. maximum: 100.

page

Optional; native body and guard rules still apply

integer

Page number for pagination. default: 1. minimum: 1. maximum: 10000.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

id

Yes

integer

The contact ID. minimum: 1.

get_by_email

Optional; native body and guard rules still apply

string

If set, looks up the contact by email address instead of the path id. format: "email".

with

Optional; native body and guard rules still apply

array

Relationships and extra data to include. Supported values: stats, subscriber.custom_values, custom_fields, commerce_stat.

with[]

Per item when supplied

string

Array item schema. Enum: ["stats", "subscriber.custom_values", "custom_fields", "commerce_stat"]

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

search

Optional; native body and guard rules still apply

string

Search term to match against contact name and email.

limit

Optional; native body and guard rules still apply

integer

Maximum number of results to return. default: 20. minimum: 1. maximum: 100.

load_default

Optional; native body and guard rules still apply

string

If truthy and no search term is provided, returns the most recent contacts. enum: ["true", "false", "1", "0", "yes"].

values

Optional; native body and guard rules still apply

array

Array of contact IDs to always include in results (useful for pre-selected values).

values[]

Per item when supplied

integer

Array item schema.

offset

Optional; native body and guard rules still apply

integer

Rows to skip before the first result. Combine with limit to page through matches. default: 0.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

email

Optional; native body and guard rules still apply

string

Contact email address. Must be unique unless __force_update is yes. format: "email".

status

Optional; native body and guard rules still apply

string

Contact subscription status. enum: ["subscribed", "pending", "unsubscribed", "bounced", "complained"].

first_name

Optional; native body and guard rules still apply

string

First name.

last_name

Optional; native body and guard rules still apply

string

Last name.

prefix

Optional; native body and guard rules still apply

string

Name prefix (e.g., Mr, Mrs, Ms).

contact_type

Optional; native body and guard rules still apply

string

Contact type. enum: ["lead", "customer"].

address_line_1

Optional; native body and guard rules still apply

string

Address line 1.

address_line_2

Optional; native body and guard rules still apply

string

Address line 2.

postal_code

Optional; native body and guard rules still apply

string

Postal/zip code.

city

Optional; native body and guard rules still apply

string

City.

state

Optional; native body and guard rules still apply

string

State or province.

country

Optional; native body and guard rules still apply

string

Two-letter country code.

phone

Optional; native body and guard rules still apply

string

Phone number.

timezone

Optional; native body and guard rules still apply

string

Timezone identifier.

date_of_birth

Optional; native body and guard rules still apply

string

Date of birth (YYYY-MM-DD).

source

Optional; native body and guard rules still apply

string

Contact source.

tags

Optional; native body and guard rules still apply

array

Tag IDs to assign.

tags[]

Per item when supplied

integer

Array item schema.

lists

Optional; native body and guard rules still apply

array

List IDs to assign.

lists[]

Per item when supplied

integer

Array item schema.

double_optin

Optional; native body and guard rules still apply

boolean

Send double opt-in confirmation email.

__force_update

Optional; native body and guard rules still apply

string

If yes, updates existing contact with the same email instead of failing. enum: ["yes", "no"].

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

confirm

Optional; native body and guard rules still apply

boolean

Set true only when the user asked for exactly this action.

payload

Optional; native body and guard rules still apply

object

Complete native JSON body; do not mix with body flags or payload_file. Arrays use repeated JSON object flags or a whole native array in a private file. additionalProperties: false. required: ["email", "status"].

payload.email

Yes

string

Contact email address. Must be unique unless __force_update is yes. format: "email".

payload.status

Yes

string

Contact subscription status. enum: ["subscribed", "pending", "unsubscribed", "bounced", "complained"].

payload.first_name

Optional; native body and guard rules still apply

string

First name.

payload.last_name

Optional; native body and guard rules still apply

string

Last name.

payload.prefix

Optional; native body and guard rules still apply

string

Name prefix (e.g., Mr, Mrs, Ms).

payload.contact_type

Optional; native body and guard rules still apply

string

Contact type. enum: ["lead", "customer"].

payload.address_line_1

Optional; native body and guard rules still apply

string

Address line 1.

payload.address_line_2

Optional; native body and guard rules still apply

string

Address line 2.

payload.postal_code

Optional; native body and guard rules still apply

string

Postal/zip code.

payload.city

Optional; native body and guard rules still apply

string

City.

payload.state

Optional; native body and guard rules still apply

string

State or province.

payload.country

Optional; native body and guard rules still apply

string

Two-letter country code.

payload.phone

Optional; native body and guard rules still apply

string

Phone number.

payload.timezone

Optional; native body and guard rules still apply

string

Timezone identifier.

payload.date_of_birth

Optional; native body and guard rules still apply

string

Date of birth (YYYY-MM-DD).

payload.source

Optional; native body and guard rules still apply

string

Contact source.

payload.tags

Optional; native body and guard rules still apply

array

Tag IDs to assign.

payload.tags[]

Per item when supplied

integer

Array item schema.

payload.lists

Optional; native body and guard rules still apply

array

List IDs to assign.

payload.lists[]

Per item when supplied

integer

Array item schema.

payload.double_optin

Optional; native body and guard rules still apply

boolean

Send double opt-in confirmation email.

payload.__force_update

Optional; native body and guard rules still apply

string

If yes, updates existing contact with the same email instead of failing. enum: ["yes", "no"].

payload_file

Optional; native body and guard rules still apply

string

Absolute regular non-symlink JSON body file, at most 1 MiB. Cannot mix with payload/body flags. minLength: 1.

Argument

Required

Type

Details

id

Yes

integer

The contact ID. minimum: 1.

subscriber

Optional; native body and guard rules still apply

object

Contact data can be nested inside a subscriber object or passed at the top level. minProperties: 1. additionalProperties: false.

subscriber.email

Optional; native body and guard rules still apply

string

Email address (must be unique). format: "email".

subscriber.first_name

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.last_name

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.prefix

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.status

Optional; native body and guard rules still apply

string

Actual shared argument definition. enum: ["subscribed", "pending", "unsubscribed", "bounced", "complained"].

subscriber.contact_type

Optional; native body and guard rules still apply

string

Actual shared argument definition. enum: ["lead", "customer"].

subscriber.address_line_1

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.address_line_2

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.postal_code

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.city

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.state

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.country

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.phone

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.timezone

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.date_of_birth

Optional; native body and guard rules still apply

['string', 'null']

Date of birth (YYYY-MM-DD). Send null or empty string to clear.

subscriber.source

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.custom_values

Optional; native body and guard rules still apply

object

Custom field key-value pairs to update. additionalProperties: {"type": "string"}.

subscriber.attach_tags

Optional; native body and guard rules still apply

array

Tag IDs to attach.

subscriber.attach_tags[]

Per item when supplied

integer

Array item schema.

subscriber.detach_tags

Optional; native body and guard rules still apply

array

Tag IDs to detach.

subscriber.detach_tags[]

Per item when supplied

integer

Array item schema.

subscriber.attach_lists

Optional; native body and guard rules still apply

array

List IDs to attach.

subscriber.attach_lists[]

Per item when supplied

integer

Array item schema.

subscriber.detach_lists

Optional; native body and guard rules still apply

array

List IDs to detach.

subscriber.detach_lists[]

Per item when supplied

integer

Array item schema.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

confirm

Optional; native body and guard rules still apply

boolean

Set true only when the user asked for exactly this action.

payload

Optional; native body and guard rules still apply

object

Complete native JSON body; do not mix with body flags or payload_file. Arrays use repeated JSON object flags or a whole native array in a private file. additionalProperties: false. required: ["subscriber"].

payload.subscriber

Yes

object

Contact data can be nested inside a subscriber object or passed at the top level. minProperties: 1. additionalProperties: false.

payload.subscriber.email

Optional; native body and guard rules still apply

string

Email address (must be unique). format: "email".

payload.subscriber.first_name

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.subscriber.last_name

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.subscriber.prefix

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.subscriber.status

Optional; native body and guard rules still apply

string

Actual shared argument definition. enum: ["subscribed", "pending", "unsubscribed", "bounced", "complained"].

payload.subscriber.contact_type

Optional; native body and guard rules still apply

string

Actual shared argument definition. enum: ["lead", "customer"].

payload.subscriber.address_line_1

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.subscriber.address_line_2

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.subscriber.postal_code

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.subscriber.city

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.subscriber.state

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.subscriber.country

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.subscriber.phone

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.subscriber.timezone

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.subscriber.date_of_birth

Optional; native body and guard rules still apply

['string', 'null']

Date of birth (YYYY-MM-DD). Send null or empty string to clear.

payload.subscriber.source

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.subscriber.custom_values

Optional; native body and guard rules still apply

object

Custom field key-value pairs to update. additionalProperties: {"type": "string"}.

payload.subscriber.attach_tags

Optional; native body and guard rules still apply

array

Tag IDs to attach.

payload.subscriber.attach_tags[]

Per item when supplied

integer

Array item schema.

payload.subscriber.detach_tags

Optional; native body and guard rules still apply

array

Tag IDs to detach.

payload.subscriber.detach_tags[]

Per item when supplied

integer

Array item schema.

payload.subscriber.attach_lists

Optional; native body and guard rules still apply

array

List IDs to attach.

payload.subscriber.attach_lists[]

Per item when supplied

integer

Array item schema.

payload.subscriber.detach_lists

Optional; native body and guard rules still apply

array

List IDs to detach.

payload.subscriber.detach_lists[]

Per item when supplied

integer

Array item schema.

payload_file

Optional; native body and guard rules still apply

string

Absolute regular non-symlink JSON body file, at most 1 MiB. Cannot mix with payload/body flags. minLength: 1.

Argument

Required

Type

Details

id

Yes

integer

The contact ID. minimum: 1.

search

Optional; native body and guard rules still apply

string

Search notes by title.

per_page

Optional; native body and guard rules still apply

integer

Number of notes per page. default: 15. minimum: 1. maximum: 100.

page

Optional; native body and guard rules still apply

integer

Page number. default: 1. minimum: 1. maximum: 10000.

include_id

Optional; native body and guard rules still apply

integer

Id of a note that must appear in the response even when it falls outside the current page. When it is not already on the page it is returned separately as included_note, scoped to this contact.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

id

Yes

integer

The contact ID. minimum: 1.

note

Optional; native body and guard rules still apply

object

Actual shared argument definition. required: ["title", "description", "type"].

note.title

Yes

string

Note title.

note.description

Yes

string

Note content (HTML). Supports SmartCode/merge tags.

note.type

Yes

string

Note type. enum: ["note", "call", "email", "meeting", "activity"].

note.created_at

Optional; native body and guard rules still apply

string

Custom creation date. Defaults to current time if not provided. format: "date-time".

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

confirm

Optional; native body and guard rules still apply

boolean

Set true only when the user asked for exactly this action.

payload

Optional; native body and guard rules still apply

object

Complete native JSON body; do not mix with body flags or payload_file. Arrays use repeated JSON object flags or a whole native array in a private file. additionalProperties: false. required: ["note"].

payload.note

Yes

object

Actual shared argument definition. required: ["title", "description", "type"].

payload.note.title

Yes

string

Note title.

payload.note.description

Yes

string

Note content (HTML). Supports SmartCode/merge tags.

payload.note.type

Yes

string

Note type. enum: ["note", "call", "email", "meeting", "activity"].

payload.note.created_at

Optional; native body and guard rules still apply

string

Custom creation date. Defaults to current time if not provided. format: "date-time".

payload_file

Optional; native body and guard rules still apply

string

Absolute regular non-symlink JSON body file, at most 1 MiB. Cannot mix with payload/body flags. minLength: 1.

Argument

Required

Type

Details

search

Optional; native body and guard rules still apply

string

Search tags by title, slug, or description.

sort_by

Optional; native body and guard rules still apply

string

Column to sort by. enum: ["id", "title", "slug", "created_at"]. default: "id".

sort_order

Optional; native body and guard rules still apply

string

Sort direction. enum: ["ASC", "DESC"]. default: "DESC".

per_page

Optional; native body and guard rules still apply

integer

Number of tags per page. default: 15. minimum: 1. maximum: 100.

page

Optional; native body and guard rules still apply

integer

Page number for pagination. default: 1. minimum: 1. maximum: 10000.

exclude_counts

Optional; native body and guard rules still apply

boolean

If set to any truthy value, subscriber counts will not be included for each tag.

all_tags

Optional; native body and guard rules still apply

boolean

If set to any truthy value, includes a flat all_tags array with id, title, and slug of every tag (useful for dropdowns).

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

search

Optional; native body and guard rules still apply

string

Search lists by title, slug, or description.

sort_by

Optional; native body and guard rules still apply

string

Column to sort by. enum: ["id", "title", "slug", "created_at"]. default: "id".

sort_order

Optional; native body and guard rules still apply

string

Sort direction. enum: ["ASC", "DESC"]. default: "DESC".

per_page

Optional; native body and guard rules still apply

integer

Number of lists per page. default: 15. minimum: 1. maximum: 100.

page

Optional; native body and guard rules still apply

integer

Page number for pagination. default: 1. minimum: 1. maximum: 10000.

exclude_counts

Optional; native body and guard rules still apply

boolean

If set to any truthy value, totalCount and subscribersCount will not be included for each list.

all_lists

Optional; native body and guard rules still apply

boolean

If set to any truthy value, includes a flat all_lists array with id, title, and slug of every list (useful for dropdowns).

with

Optional; native body and guard rules still apply

array

Extra data to include. subscribersCount adds per-list contact counts via one grouped pivot query.

with[]

Per item when supplied

string

Array item schema.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

searchBy

Optional; native body and guard rules still apply

string

Search campaigns by title.

statuses

Optional; native body and guard rules still apply

array

Filter by campaign statuses.

statuses[]

Per item when supplied

string

Array item schema. Enum: ["draft", "processing", "pending-scheduled", "scheduled", "working", "paused", "archived"]

sort_by

Optional; native body and guard rules still apply

string

Column to sort by. default: "created_at".

sort_type

Optional; native body and guard rules still apply

string

Sort direction. enum: ["ASC", "DESC"]. default: "DESC".

with

Optional; native body and guard rules still apply

array

Include related data. Use stats to include campaign statistics and labels.

with[]

Per item when supplied

string

Array item schema. Enum: ["stats"]

labels

Optional; native body and guard rules still apply

array

Filter by label IDs.

labels[]

Per item when supplied

integer

Array item schema.

per_page

Optional; native body and guard rules still apply

integer

Number of results per page. default: 15. minimum: 1. maximum: 100.

page

Optional; native body and guard rules still apply

integer

Page number. default: 1. minimum: 1. maximum: 10000.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

id

Yes

integer

The campaign ID. minimum: 1.

with

Optional; native body and guard rules still apply

array

Include related data (e.g., template, subjects).

with[]

Per item when supplied

string

Array item schema.

viewCampaign

Optional; native body and guard rules still apply

string

If set, returns the campaign with paginated emails instead of the standard response.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

id

Yes

integer

The campaign ID. minimum: 1.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

order

Optional; native body and guard rules still apply

string

Sort direction. enum: ["asc", "desc"]. default: "desc".

orderBy

Optional; native body and guard rules still apply

string

Column to sort by. default: "id".

search

Optional; native body and guard rules still apply

string

Search sequences by title.

with

Optional; native body and guard rules still apply

array

Include additional data. Use stats to include email count, subscriber count, and revenue for each sequence.

with[]

Per item when supplied

string

Array item schema. Enum: ["stats"]

per_page

Optional; native body and guard rules still apply

integer

Number of sequences per page. default: 15. minimum: 1. maximum: 100.

page

Optional; native body and guard rules still apply

integer

Page number for pagination. default: 1. minimum: 1. maximum: 10000.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

sort_by

Optional; native body and guard rules still apply

string

Column to sort by. default: "id".

sort_type

Optional; native body and guard rules still apply

string

Sort direction. enum: ["ASC", "DESC"]. default: "DESC".

search

Optional; native body and guard rules still apply

string

Search funnels by title (partial match).

labels

Optional; native body and guard rules still apply

array

Filter funnels by label IDs.

labels[]

Per item when supplied

integer

Array item schema.

with

Optional; native body and guard rules still apply

array

Include additional related data. Supported values: triggers.

with[]

Per item when supplied

string

Array item schema. Enum: ["triggers"]

per_page

Optional; native body and guard rules still apply

integer

Number of funnels per page. default: 15. minimum: 1. maximum: 100.

page

Optional; native body and guard rules still apply

integer

Page number for pagination. default: 1. minimum: 1. maximum: 10000.

tags

Optional; native body and guard rules still apply

array

Only automations whose contacts carry these tag ids.

tags[]

Per item when supplied

integer

Array item schema.

lists

Optional; native body and guard rules still apply

array

Only automations whose contacts are on these list ids.

lists[]

Per item when supplied

integer

Array item schema.

statuses

Optional; native body and guard rules still apply

array

Filter automations by status, e.g. published or draft.

statuses[]

Per item when supplied

string

Array item schema.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

id

Yes

integer

The funnel ID. minimum: 1.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

id

Yes

integer

The contact ID. minimum: 1.

filter

Optional; native body and guard rules still apply

string

Filter emails by engagement status. enum: ["open", "click", "unopened"].

tab

Optional; native body and guard rules still apply

string

Email source tab. Use fluentsmtp to show FluentSMTP logs instead of CRM campaign emails. enum: ["crm", "fluentsmtp"]. default: "crm".

per_page

Optional; native body and guard rules still apply

integer

Number of emails per page. default: 15. minimum: 1. maximum: 100.

page

Optional; native body and guard rules still apply

integer

Page number. default: 1. minimum: 1. maximum: 10000.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

slug

Yes

string

SpaceSlug extracted from the URL path. minLength: 1. pattern: "^(?!\.{1,2}$)[^/\\\\\\x00-\\x1f?#]+$".

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

space

Optional; native body and guard rules still apply

string

Space read via $request->get() in get().

user_id

Optional; native body and guard rules still apply

string

User ID read via $request->getSafe() in get().

topic_slug

Optional; native body and guard rules still apply

string

Topic Slug read via $request->getSafe() in get().

search

Optional; native body and guard rules still apply

string

Search read via $request->getSafe() in get().

status

Optional; native body and guard rules still apply

string

Status read via $request->getSafe() in get().

per_page

Optional; native body and guard rules still apply

integer

Per Page read via $request->get() in get(). default: 10. minimum: 1. maximum: 100.

page

Optional; native body and guard rules still apply

integer

Page read via $request->get() in get(). default: 1. minimum: 1. maximum: 10000.

search_in

Optional; native body and guard rules still apply

array

Search In read via $request->get() in get(). default: ["post_content"].

order_by_type

Optional; native body and guard rules still apply

string

Order By Type read via $request->getSafe() in get().

disable_sticky

Optional; native body and guard rules still apply

string

Disable Sticky read via $request->get() in get().

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

feed_id

Yes

integer

Feed ID extracted from the URL path. minimum: 1.

context

Optional; native body and guard rules still apply

string

Prose-documented delegated edit context, requiring native post edit access. enum: ["view", "edit"].

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

space

Optional; native body and guard rules still apply

string

Actual shared argument definition.

topic_ids

Optional; native body and guard rules still apply

array

Actual shared argument definition.

topic_ids[]

Per item when supplied

string

Array item schema.

send_announcement_email

Optional; native body and guard rules still apply

string

Actual shared argument definition.

content_type

Optional; native body and guard rules still apply

string

Actual shared argument definition.

message

Optional; native body and guard rules still apply

string

Actual shared argument definition. minLength: 1.

survey

Optional; native body and guard rules still apply

object

Actual shared argument definition. required: [].

survey.options

Optional; native body and guard rules still apply

array

Actual shared argument definition.

survey.options[]

Per item when supplied

string

Array item schema.

survey.end_date

Optional; native body and guard rules still apply

string

Actual shared argument definition.

survey.type

Optional; native body and guard rules still apply

string

Actual shared argument definition.

title

Optional; native body and guard rules still apply

string

Actual shared argument definition.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

confirm

Optional; native body and guard rules still apply

boolean

Set true only when the user asked for exactly this action.

payload

Optional; native body and guard rules still apply

object

Complete native JSON body; do not mix with body flags or payload_file. Arrays use repeated JSON object flags or a whole native array in a private file. additionalProperties: false. required: ["message"].

payload.space

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.topic_ids

Optional; native body and guard rules still apply

array

Actual shared argument definition.

payload.topic_ids[]

Per item when supplied

string

Array item schema.

payload.send_announcement_email

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.content_type

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.message

Yes

string

Actual shared argument definition. minLength: 1.

payload.survey

Optional; native body and guard rules still apply

object

Actual shared argument definition. required: [].

payload.survey.options

Optional; native body and guard rules still apply

array

Actual shared argument definition.

payload.survey.options[]

Per item when supplied

string

Array item schema.

payload.survey.end_date

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.survey.type

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.title

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload_file

Optional; native body and guard rules still apply

string

Absolute regular non-symlink JSON body file, at most 1 MiB. Cannot mix with payload/body flags. minLength: 1.

Argument

Required

Type

Details

feed_id

Yes

integer

Feed ID extracted from the URL path. minimum: 1.

new_space_id

Optional; native body and guard rules still apply

string

Actual shared argument definition.

move_to_profile

Optional; native body and guard rules still apply

string

Actual shared argument definition.

survey

Optional; native body and guard rules still apply

object

Actual shared argument definition. required: [].

survey.options

Optional; native body and guard rules still apply

array

Actual shared argument definition.

survey.options[]

Per item when supplied

string

Array item schema.

survey.end_date

Optional; native body and guard rules still apply

string

Actual shared argument definition.

survey.type

Optional; native body and guard rules still apply

string

Actual shared argument definition.

status

Optional; native body and guard rules still apply

string

Actual shared argument definition.

send_announcement_email

Optional; native body and guard rules still apply

string

Actual shared argument definition.

content_type

Optional; native body and guard rules still apply

string

Actual shared argument definition.

media_images

Optional; native body and guard rules still apply

string

Actual shared argument definition.

topic_ids

Optional; native body and guard rules still apply

array

Actual shared argument definition.

topic_ids[]

Per item when supplied

string

Array item schema.

message

Optional; native body and guard rules still apply

string

Actual shared argument definition. minLength: 1.

title

Optional; native body and guard rules still apply

string

Actual shared argument definition.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

confirm

Optional; native body and guard rules still apply

boolean

Set true only when the user asked for exactly this action.

payload

Optional; native body and guard rules still apply

object

Complete native JSON body; do not mix with body flags or payload_file. Arrays use repeated JSON object flags or a whole native array in a private file. additionalProperties: false. required: ["message"].

payload.new_space_id

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.move_to_profile

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.survey

Optional; native body and guard rules still apply

object

Actual shared argument definition. required: [].

payload.survey.options

Optional; native body and guard rules still apply

array

Actual shared argument definition.

payload.survey.options[]

Per item when supplied

string

Array item schema.

payload.survey.end_date

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.survey.type

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.status

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.send_announcement_email

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.content_type

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.media_images

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.topic_ids

Optional; native body and guard rules still apply

array

Actual shared argument definition.

payload.topic_ids[]

Per item when supplied

string

Array item schema.

payload.message

Yes

string

Actual shared argument definition. minLength: 1.

payload.title

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload_file

Optional; native body and guard rules still apply

string

Absolute regular non-symlink JSON body file, at most 1 MiB. Cannot mix with payload/body flags. minLength: 1.

Argument

Required

Type

Details

feed_id

Yes

integer

Feed ID extracted from the URL path. minimum: 1.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

confirm

Optional; native body and guard rules still apply

boolean

Set true only when the user asked for exactly this action.

Argument

Required

Type

Details

feed_id

Yes

integer

Feed ID extracted from the URL path. minimum: 1.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

feed_id

Yes

integer

Feed ID extracted from the URL path. minimum: 1.

comment

Optional; native body and guard rules still apply

string

Actual shared argument definition. minLength: 1.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

confirm

Optional; native body and guard rules still apply

boolean

Set true only when the user asked for exactly this action.

payload

Optional; native body and guard rules still apply

object

Complete native JSON body; do not mix with body flags or payload_file. Arrays use repeated JSON object flags or a whole native array in a private file. additionalProperties: false. required: ["comment"].

payload.comment

Yes

string

Actual shared argument definition. minLength: 1.

payload_file

Optional; native body and guard rules still apply

string

Absolute regular non-symlink JSON body file, at most 1 MiB. Cannot mix with payload/body flags. minLength: 1.

Argument

Required

Type

Details

feed_id

Yes

integer

Feed ID extracted from the URL path. minimum: 1.

comment_id

Yes

integer

Comment ID extracted from the URL path. minimum: 1.

comment

Optional; native body and guard rules still apply

string

Actual shared argument definition. minLength: 1.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

confirm

Optional; native body and guard rules still apply

boolean

Set true only when the user asked for exactly this action.

payload

Optional; native body and guard rules still apply

object

Complete native JSON body; do not mix with body flags or payload_file. Arrays use repeated JSON object flags or a whole native array in a private file. additionalProperties: false. required: ["comment"].

payload.comment

Yes

string

Actual shared argument definition. minLength: 1.

payload_file

Optional; native body and guard rules still apply

string

Absolute regular non-symlink JSON body file, at most 1 MiB. Cannot mix with payload/body flags. minLength: 1.

Argument

Required

Type

Details

feed_id

Yes

integer

Feed ID extracted from the URL path. minimum: 1.

comment_id

Yes

integer

Comment ID extracted from the URL path. minimum: 1.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

confirm

Optional; native body and guard rules still apply

boolean

Set true only when the user asked for exactly this action.

Argument

Required

Type

Details

feed_id

Yes

integer

Feed ID extracted from the URL path. minimum: 1.

react_type

Optional; native body and guard rules still apply

string

Actual shared argument definition.

remove

Optional; native body and guard rules still apply

string

Actual shared argument definition.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

confirm

Optional; native body and guard rules still apply

boolean

Set true only when the user asked for exactly this action.

payload

Optional; native body and guard rules still apply

object

Complete native JSON body; do not mix with body flags or payload_file. Arrays use repeated JSON object flags or a whole native array in a private file. additionalProperties: false.

payload.react_type

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload.remove

Optional; native body and guard rules still apply

string

Actual shared argument definition.

payload_file

Optional; native body and guard rules still apply

string

Absolute regular non-symlink JSON body file, at most 1 MiB. Cannot mix with payload/body flags. minLength: 1.

Argument

Required

Type

Details

status

Optional; native body and guard rules still apply

string

Status read via $request->getSafe() in getCourses().

sort_by

Optional; native body and guard rules still apply

string

Sort By read via $request->getSafe() in getCourses(). default: "latest".

topic_slug

Optional; native body and guard rules still apply

string

Topic Slug read via $request->getSafe() in getCourses().

search

Optional; native body and guard rules still apply

string

Search read via $request->getSafe() in getCourses().

with_categories

Optional; native body and guard rules still apply

string

With Categories read via $request->get() in getCourses().

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

course_id

Yes

integer

Course ID extracted from the URL path. minimum: 1.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

course_id

Yes

integer

Course ID extracted from the URL path. minimum: 1.

search

Optional; native body and guard rules still apply

string

Search read via $request->getSafe() in getCourseStudents().

sort_by

Optional; native body and guard rules still apply

string

Sort By read via $request->getSafe() in getCourseStudents(). default: "created_at".

sort_dir

Optional; native body and guard rules still apply

string

Sort Dir read via $request->getSafe() in getCourseStudents().

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

course_id

Yes

integer

Course ID extracted from the URL path. minimum: 1.

topic_id

Optional; native body and guard rules still apply

string

Topic ID read via $request->get() in getLessons().

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

slug

Yes

string

SpaceSlug extracted from the URL path. minLength: 1. pattern: "^(?!\.{1,2}$)[^/\\\\\\x00-\\x1f?#]+$".

search

Optional; native body and guard rules still apply

string

Search read via $request->getSafe() in getMembers().

status

Optional; native body and guard rules still apply

string

Status read via $request->get() in getMembers().

sort_by

Optional; native body and guard rules still apply

string

Sort By read via $request->getSafe() in getMembers(). default: "created_at".

sort_dir

Optional; native body and guard rules still apply

string

Sort Dir read via $request->getSafe() in getMembers().

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

username

Yes

string

Username extracted from the URL path. minLength: 1. pattern: "^(?!\.{1,2}$)[^/\\\\\\x00-\\x1f?#]+$".

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

user_id

Optional; native body and guard rules still apply

string

User ID read via $request->getSafe() in getScheduledPosts(). default: "$currentUserId".

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

search

Optional; native body and guard rules still apply

string

Actual shared argument definition.

status

Optional; native body and guard rules still apply

string

Actual shared argument definition.

filter_by

Optional; native body and guard rules still apply

string

Actual shared argument definition.

date_range

Optional; native body and guard rules still apply

array

Actual shared argument definition.

date_range[]

Per item when supplied

string

Array item schema.

sort_column

Optional; native body and guard rules still apply

string

Actual shared argument definition.

sort_by

Optional; native body and guard rules still apply

string

Actual shared argument definition. enum: ["ASC", "DESC"].

per_page

Optional; native body and guard rules still apply

integer

Actual shared argument definition. minimum: 1. maximum: 100.

page

Optional; native body and guard rules still apply

integer

Actual shared argument definition. minimum: 1. maximum: 10000.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

form_id

Yes

integer

Actual shared argument definition. minimum: 1.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

form_id

Yes

integer

Actual shared argument definition. minimum: 1.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

form_id

Yes

integer

Actual shared argument definition. minimum: 1.

per_page

Optional; native body and guard rules still apply

integer

Actual shared argument definition. minimum: 1. maximum: 100.

page

Optional; native body and guard rules still apply

integer

Actual shared argument definition. minimum: 1. maximum: 10000.

search

Optional; native body and guard rules still apply

string

Actual shared argument definition.

entry_type

Optional; native body and guard rules still apply

string

Actual shared argument definition.

date_range

Optional; native body and guard rules still apply

array

Actual shared argument definition. minItems: 2. maxItems: 2.

date_range[]

Per item when supplied

string

Array item schema.

payment_statuses

Optional; native body and guard rules still apply

array

Actual shared argument definition.

payment_statuses[]

Per item when supplied

string

Array item schema.

sort_by

Optional; native body and guard rules still apply

string

Actual shared argument definition. enum: ["ASC", "DESC"].

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

form_id

Yes

integer

Actual shared argument definition. minimum: 1.

statuses

Optional; native body and guard rules still apply

array

Actual shared argument definition.

statuses[]

Per item when supplied

string

Array item schema.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

confirm

Optional; native body and guard rules still apply

boolean

Set true only when the user asked for exactly this action.

Argument

Required

Type

Details

form_id

Optional; native body and guard rules still apply

integer

Actual shared argument definition. minimum: 1.

start_date

Optional; native body and guard rules still apply

string

Actual shared argument definition.

end_date

Optional; native body and guard rules still apply

string

Actual shared argument definition.

metric

Optional; native body and guard rules still apply

string

Actual shared argument definition.

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

context

Optional; native body and guard rules still apply

string

Actual shared argument definition. enum: ["view", "embed"].

account

Optional; native body and guard rules still apply

string

Exact configured private account profile label; not a tenant or provider account ID.

Argument

Required

Type

Details

No arguments

Not required

Local discovery

No credential or provider request required.

Argument

Required

Type

Details

operation

Yes

string

Actual native tool name, including fc_update_feed and ff_list_submissions. enum: ["fcrm_dashboard_stats", "fcrm_list_contacts", "fcrm_get_contact", "fcrm_search_contacts", "fcrm_create_contact", "fcrm_update_contact", "fcrm_contact_notes", "fcrm_add_contact_note", "fcrm_list_tags", "fcrm_list_lists", "fcrm_list_campaigns", "fcrm_get_campaign", "fcrm_campaign_stats", "fcrm_list_sequences", "fcrm_list_automations", "fcrm_automation_report", "fcrm_contact_emails", "fc_list_spaces", "fc_get_space", "fc_list_feeds", "fc_get_feed", "fc_create_feed", "fc_update_feed", "fc_delete_feed", "fc_list_comments", "fc_create_comment", "fc_update_comment", "fc_delete_comment", "fc_react_to_feed", "fc_list_courses", "fc_get_course", "fc_course_students", "fc_course_lessons", "fc_space_members", "fc_get_profile", "fc_scheduled_posts", "fc_analytics_top_members", "fc_analytics_top_commenters", "fc_analytics_top_post_starters", "fc_analytics_member_activity", "ff_list_forms", "ff_get_form", "ff_form_fields", "ff_list_submissions", "ff_form_report", "ff_form_stats", "get_current_user"].

Argument

Required

Type

Details

account

Optional; native body and guard rules still apply

string

Exact configured private site profile label, not a verified site-owner identity.

type

Optional; native body and guard rules still apply

string

One native report, default top-members. enum: ["top-members", "top-commenters", "top-post-starters", "activity"].

Argument

Required

Type

Details

tasks

Yes

array

One to twenty exact ordered native requests. Each read is one native response/page; no automatic pagination, URL following, polling or cross-site override. minItems: 1. maxItems: 20.

tasks[]

Per item when supplied

object

Array item schema.

tasks[].tool

Yes

string

Actual shared argument definition. enum: ["fcrm_create_contact", "fcrm_update_contact", "fcrm_add_contact_note", "fc_create_feed", "fc_update_feed", "fc_delete_feed", "fc_create_comment", "fc_update_comment", "fc_delete_comment", "fc_react_to_feed"].

tasks[].arguments

Yes

object

Native arguments without account, confirm, payload_file or output_file; complete payload is allowed.

account

Optional; native body and guard rules still apply

string

Exact configured private site profile label, not a verified site-owner identity.

Argument

Required

Type

Details

tasks

Yes

array

One to twenty exact ordered native requests. Each read is one native response/page; no automatic pagination, URL following, polling or cross-site override. minItems: 1. maxItems: 20.

tasks[]

Per item when supplied

object

Array item schema.

tasks[].tool

Yes

string

Actual shared argument definition. enum: ["fcrm_create_contact", "fcrm_update_contact", "fcrm_add_contact_note", "fc_create_feed", "fc_update_feed", "fc_delete_feed", "fc_create_comment", "fc_update_comment", "fc_delete_comment", "fc_react_to_feed"].

tasks[].arguments

Yes

object

Native arguments without account, confirm, payload_file or output_file; complete payload is allowed.

account

Optional; native body and guard rules still apply

string

Exact configured private site profile label, not a verified site-owner identity.

confirm

Optional; native body and guard rules still apply

boolean

Set true only when the user asked for exactly this action.

review_sha256

Yes

string

Exact preview_site_batch hash for unchanged tasks, site profile and schema. pattern: "^[a-f0-9]{64}$".

Argument

Required

Type

Details

tasks

Yes

array

One to twenty exact ordered native requests. Each read is one native response/page; no automatic pagination, URL following, polling or cross-site override. minItems: 1. maxItems: 20.

tasks[]

Per item when supplied

object

Array item schema.

tasks[].tool

Yes

string

Actual shared argument definition. enum: ["fcrm_dashboard_stats", "fcrm_list_contacts", "fcrm_get_contact", "fcrm_search_contacts", "fcrm_contact_notes", "fcrm_list_tags", "fcrm_list_lists", "fcrm_list_campaigns", "fcrm_get_campaign", "fcrm_campaign_stats", "fcrm_list_sequences", "fcrm_list_automations", "fcrm_automation_report", "fcrm_contact_emails", "fc_list_spaces", "fc_get_space", "fc_list_feeds", "fc_get_feed", "fc_list_comments", "fc_list_courses", "fc_get_course", "fc_course_students", "fc_course_lessons", "fc_space_members", "fc_get_profile", "fc_scheduled_posts", "fc_analytics_top_members", "fc_analytics_top_commenters", "fc_analytics_top_post_starters", "fc_analytics_member_activity", "ff_list_forms", "ff_get_form", "ff_form_fields", "ff_list_submissions", "ff_form_stats", "get_current_user"].

tasks[].arguments

Yes

object

Native arguments without account, confirm, payload_file or output_file; complete payload is allowed.

account

Optional; native body and guard rules still apply

string

Exact configured private site profile label, not a verified site-owner identity.

Argument

Required

Type

Details

tasks

Yes

array

One to twenty exact ordered native requests. Each read is one native response/page; no automatic pagination, URL following, polling or cross-site override. minItems: 1. maxItems: 20.

tasks[]

Per item when supplied

object

Array item schema.

tasks[].tool

Yes

string

Actual shared argument definition. enum: ["fcrm_dashboard_stats", "fcrm_list_contacts", "fcrm_get_contact", "fcrm_search_contacts", "fcrm_contact_notes", "fcrm_list_tags", "fcrm_list_lists", "fcrm_list_campaigns", "fcrm_get_campaign", "fcrm_campaign_stats", "fcrm_list_sequences", "fcrm_list_automations", "fcrm_automation_report", "fcrm_contact_emails", "fc_list_spaces", "fc_get_space", "fc_list_feeds", "fc_get_feed", "fc_list_comments", "fc_list_courses", "fc_get_course", "fc_course_students", "fc_course_lessons", "fc_space_members", "fc_get_profile", "fc_scheduled_posts", "fc_analytics_top_members", "fc_analytics_top_commenters", "fc_analytics_top_post_starters", "fc_analytics_member_activity", "ff_list_forms", "ff_get_form", "ff_form_fields", "ff_list_submissions", "ff_form_stats", "get_current_user"].

tasks[].arguments

Yes

object

Native arguments without account, confirm, payload_file or output_file; complete payload is allowed.

account

Optional; native body and guard rules still apply

string

Exact configured private site profile label, not a verified site-owner identity.

confirm

Optional; native body and guard rules still apply

boolean

Set true only when the user asked for exactly this action.

output_file

Yes

string

Absolute new file in an existing private directory; restrict Windows ACLs separately. minLength: 1.

Native argument

Location

Required

Schema

No path/query arguments

None

No

Native permissions and body/guard rules still apply.

Native argument

Location

Required

Schema

filter_type

query

No

{"type": "string", "default": "simple", "enum": ["simple", "advanced"], "description": "Type of filtering to apply."}

search

query

No

{"type": "string", "description": "Search contacts by name, email, or other searchable fields."}

sort_by

query

No

{"type": "string", "default": "id", "description": "Column to sort by."}

sort_type

query

No

{"type": "string", "default": "DESC", "enum": ["ASC", "DESC"], "description": "Sort direction."}

has_commerce

query

No

{"type": "string", "description": "Filter by commerce integration availability."}

custom_fields

query

No

{"type": "string", "enum": ["true", "false"], "description": "Set to true to include custom field values in the response."}

tags[]

query

No

{"type": "array", "items": {"type": "integer"}, "description": "Filter by tag IDs (simple filter mode only)."}

statuses[]

query

No

{"type": "array", "items": {"type": "string", "enum": ["subscribed", "pending", "unsubscribed", "bounced", "complained"]}, "description": "Filter by contact statuses (simple filter mode only)."}

sms_statuses[]

query

No

{"type": "array", "items": {"type": "string", "enum": ["sms_subscribed", "sms_unsubscribed", "sms_pending", "sms_bounced"]}, "description": "Filter by SMS statuses (simple filter mode only)."}

lists[]

query

No

{"type": "array", "items": {"type": "integer"}, "description": "Filter by list IDs (simple filter mode only)."}

company_ids[]

query

No

{"type": "array", "items": {"type": "integer"}, "description": "Filter by company IDs."}

advanced_filters

query

No

{"type": "string", "description": "JSON-encoded advanced filter groups (advanced filter mode only)."}

per_page

query

No

{"type": "integer", "default": 15, "description": "Number of contacts per page.", "minimum": 1, "maximum": 100}

page

query

No

{"type": "integer", "default": 1, "description": "Page number for pagination.", "minimum": 1, "maximum": 10000}

Native argument

Location

Required

Schema

id

path

Yes

{"type": "integer", "description": "The contact ID.", "minimum": 1}

get_by_email

query

No

{"type": "string", "format": "email", "description": "If set, looks up the contact by email address instead of the path id."}

with[]

query

No

{"type": "array", "items": {"type": "string", "enum": ["stats", "subscriber.custom_values", "custom_fields", "commerce_stat"]}, "description": "Relationships and extra data to include. Supported values: stats, subscriber.custom_values, custom_fields, commerce_stat."}

Native argument

Location

Required

Schema

search

query

No

{"type": "string", "description": "Search term to match against contact name and email."}

limit

query

No

{"type": "integer", "default": 20, "description": "Maximum number of results to return.", "minimum": 1, "maximum": 100}

load_default

query

No

{"type": "string", "enum": ["true", "false", "1", "0", "yes"], "description": "If truthy and no search term is provided, returns the most recent contacts."}

values[]

query

No

{"type": "array", "items": {"type": "integer"}, "description": "Array of contact IDs to always include in results (useful for pre-selected values)."}

offset

query

No

{"type": "integer", "default": 0, "description": "Rows to skip before the first result. Combine with limit to page through matches."}

Native argument

Location

Required

Schema

No path/query arguments

None

No

Native permissions and body/guard rules still apply.

Body field

Required

Type

Details

email

Yes

string

Contact email address. Must be unique unless __force_update is yes. format: "email".

status

Yes

string

Contact subscription status. enum: ["subscribed", "pending", "unsubscribed", "bounced", "complained"].

first_name

Optional; native body and guard rules still apply

string

First name.

last_name

Optional; native body and guard rules still apply

string

Last name.

prefix

Optional; native body and guard rules still apply

string

Name prefix (e.g., Mr, Mrs, Ms).

contact_type

Optional; native body and guard rules still apply

string

Contact type. enum: ["lead", "customer"].

address_line_1

Optional; native body and guard rules still apply

string

Address line 1.

address_line_2

Optional; native body and guard rules still apply

string

Address line 2.

postal_code

Optional; native body and guard rules still apply

string

Postal/zip code.

city

Optional; native body and guard rules still apply

string

City.

state

Optional; native body and guard rules still apply

string

State or province.

country

Optional; native body and guard rules still apply

string

Two-letter country code.

phone

Optional; native body and guard rules still apply

string

Phone number.

timezone

Optional; native body and guard rules still apply

string

Timezone identifier.

date_of_birth

Optional; native body and guard rules still apply

string

Date of birth (YYYY-MM-DD).

source

Optional; native body and guard rules still apply

string

Contact source.

tags

Optional; native body and guard rules still apply

array

Tag IDs to assign.

tags[]

Per item when supplied

integer

Array item schema.

lists

Optional; native body and guard rules still apply

array

List IDs to assign.

lists[]

Per item when supplied

integer

Array item schema.

double_optin

Optional; native body and guard rules still apply

boolean

Send double opt-in confirmation email.

__force_update

Optional; native body and guard rules still apply

string

If yes, updates existing contact with the same email instead of failing. enum: ["yes", "no"].

Native argument

Location

Required

Schema

id

path

Yes

{"type": "integer", "description": "The contact ID.", "minimum": 1}

Body field

Required

Type

Details

subscriber

Yes

object

Contact data can be nested inside a subscriber object or passed at the top level. minProperties: 1. additionalProperties: false.

subscriber.email

Optional; native body and guard rules still apply

string

Email address (must be unique). format: "email".

subscriber.first_name

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.last_name

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.prefix

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.status

Optional; native body and guard rules still apply

string

Actual shared argument definition. enum: ["subscribed", "pending", "unsubscribed", "bounced", "complained"].

subscriber.contact_type

Optional; native body and guard rules still apply

string

Actual shared argument definition. enum: ["lead", "customer"].

subscriber.address_line_1

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.address_line_2

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.postal_code

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.city

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.state

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.country

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.phone

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.timezone

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.date_of_birth

Optional; native body and guard rules still apply

['string', 'null']

Date of birth (YYYY-MM-DD). Send null or empty string to clear.

subscriber.source

Optional; native body and guard rules still apply

string

Actual shared argument definition.

subscriber.custom_values

Optional; native body and guard rules still apply

object

Custom field key-value pairs to update. additionalProperties: {"type": "string"}.

subscriber.attach_tags

Optional; native body and guard rules still apply

array

Tag IDs to attach.

subscriber.attach_tags[]

Per item when supplied

integer

Array item schema.

subscriber.detach_tags

Optional; native body and guard rules still apply

array

Tag IDs to detach.

subscriber.detach_tags[]

Per item when supplied

integer

Array item schema.

subscriber.attach_lists

Optional; native body and guard rules still apply

array

List IDs to attach.

subscriber.attach_lists[]

Per item when supplied

integer

Array item schema.

subscriber.detach_lists

Optional; native body and guard rules still apply

array

List IDs to detach.

subscriber.detach_lists[]

Per item when supplied

integer

Array item schema.

Native argument

Location

Required

Schema

id

path

Yes

{"type": "integer", "description": "The contact ID.", "minimum": 1}

search

query

No

{"type": "string", "description": "Search notes by title."}

per_page

query

No

{"type": "integer", "default": 15, "description": "Number of notes per page.", "minimum": 1, "maximum": 100}

page

query

No

{"type": "integer", "default": 1, "description": "Page number.", "minimum": 1, "maximum": 10000}

include_id

query

No

{"type": "integer", "description": "Id of a note that must appear in the response even when it falls outside the current page. When it is not already on the page it is returned separately as included_note, scoped to this contact."}

Native argument

Location

Required

Schema

id

path

Yes

{"type": "integer", "description": "The contact ID.", "minimum": 1}

Body field

Required

Type

Details

note

Yes

object

Actual shared argument definition. required: ["title", "description", "type"].

note.title

Yes

string

Note title.

note.description

Yes

string

Note content (HTML). Supports SmartCode/merge tags.

note.type

Yes

string

Note type. enum: ["note", "call", "email", "meeting", "activity"].

note.created_at

Optional; native body and guard rules still apply

string

Custom creation date. Defaults to current time if not provided. format: "date-time".

Native argument

Location

Required

Schema

search

query

No

{"type": "string", "description": "Search tags by title, slug, or description."}

sort_by

query

No

{"type": "string", "default": "id", "enum": ["id", "title", "slug", "created_at"], "description": "Column to sort by."}

sort_order

query

No

{"type": "string", "default": "DESC", "enum": ["ASC", "DESC"], "description": "Sort direction."}

per_page

query

No

{"type": "integer", "default": 15, "description": "Number of tags per page.", "minimum": 1, "maximum": 100}

page

query

No

{"type": "integer", "default": 1, "description": "Page number for pagination.", "minimum": 1, "maximum": 10000}

exclude_counts

query

No

{"type": "boolean", "description": "If set to any truthy value, subscriber counts will not be included for each tag."}

all_tags

query

No

{"type": "boolean", "description": "If set to any truthy value, includes a flat all_tags array with id, title, and slug of every tag (useful for dropdowns)."}

Native argument

Location

Required

Schema

search

query

No