# Extole MCP connector

The Extole connector brings referral program users, audiences, components, and client domains to Claude, ChatGPT, Cursor, and the Elaichi Agent, so your team can look up and manage them with each person signed in as themselves.

Source: https://elaichi.ai/connectors/extole/

## Facts

| | |
| --- | --- |
| Application | Extole |
| Category | Marketing Automation |
| AI tools | 340 |
| Authentication | Connects with an API key |
| Needs your own OAuth app | No |
| MCP endpoint | https://api.elaichi.ai/mcp |
| Works with | Claude, ChatGPT, Cursor, any MCP client, and the Elaichi Agent |
| Tools advertised by name | No. 340 tools is past the 30-tool threshold, so clients use `search_tools` and `execute_tool` |

## What you can ask once Extole is connected

- List the Extole audiences we have built so far
- Add these five new advocates as Extole users
- Show the component diffs on the referral program before we publish

## Connect Extole in Elaichi

This happens once for the organization, before any client is involved.

1. Open Connections, choose Add connection, and pick Extole.
2. Optionally set Share with, then press Connect.
3. Paste an Extole API key. One person generates a token in Extole and pastes it once. Everyone else works through Share with, and never sees it.

Credentials are vaulted and nobody, including the AI, reads them back. The connection becomes a toolbox immediately, so you can curate which Extole tools are exposed, rename them, or freeze arguments before anyone points a client at it.

## Connect Extole to Claude

Endpoint: https://api.elaichi.ai/mcp

1. Open Customize, then Connectors.
2. Press Add.
3. Name it, paste the MCP server URL, then Continue.
4. Sign in and approve.

On Team and Enterprise, an Owner adds it once. Everyone else turns it on for themselves.

## Connect Extole to ChatGPT

Endpoint: https://api.elaichi.ai/mcp

1. Open Plugins, then press the + button.
2. Name it and paste the endpoint into Server URL.
3. Leave Authentication on OAuth, then tick the risk acknowledgement.
4. Press Create, then sign in and approve.

Works on the web today. The plugin directory lives at chatgpt.com/plugins.

## Connect Extole to Cursor

Endpoint: https://api.elaichi.ai/mcp

1. Open `~/.cursor/mcp.json`.
2. Add the endpoint under `mcpServers`.
3. Reload Cursor, then sign in and approve.

Set up per machine, so repeat it on each computer you work from.

## Connect Extole to any MCP client

Endpoint: https://api.elaichi.ai/mcp

1. Add the endpoint as a remote MCP server.
2. Sign in and approve.

The Elaichi Agent already has these tools, with nothing to set up.

## What the consent screen decides

Only Read is granted by default, which is not enough to call a Extole tool. Over MCP there is no trusted place to confirm a write in the moment, so the consent screen is the standing approval rather than a formality. Grant Read and Run tools. Think hard before granting Delete, which reaches into connected apps and cannot be undone.

## What teams do with Extole through Elaichi

### See who is in a referral audience

Marketing. Ask which Extole audiences exist, which ones have been built, and what each one contains before you launch a campaign against it.

### Add new advocates to the program

Growth. Paste in a list of customers after a launch and have them created as Extole users in one go, ready to start referring.

### Find a referrer and restore a locked account

Support. Look up an Extole user by ID or status when a customer calls, then restore their access or attach the subscription they were promised.

### Review component changes before publishing

Marketing Ops. Pull the diffs on a program component and check its operation state so nothing goes live in Extole with an unnoticed change.

### Pull translatable text from program components

Localization. List the translatable formats on each Extole component so the copy can be sent for translation without opening every screen.

### Manage the domains a program runs on

Web. Add a new client domain when a brand site launches, check a single domain by ID, and remove domains that are no longer in use.

## Frequently asked questions

### How do I connect Extole to Claude?

Connect Extole in Elaichi by pasting in your Extole API key, then open Claude, go to Customize, then Connectors, then Add, and paste the endpoint https://api.elaichi.ai/mcp. There is no OAuth application to register in Extole and no client ID or secret to generate. Once Claude is connected, you sign in to Elaichi as yourself and Extole appears as a connector.

### Does Extole work with ChatGPT and Cursor as well as Claude?

Yes. Once Extole is connected in Elaichi, the same endpoint, https://api.elaichi.ai/mcp, works in Claude, ChatGPT, Cursor, any other MCP client, and the Elaichi Agent. You connect Extole once and every client picks it up.

### What can an AI agent actually do with my Extole data?

An agent can look up referral users, add new ones, attach a subscription, restore a locked account, and list the audiences you have built in Extole. It can also read program components, show what changed between versions, pull translatable text, and check on client domains and operation states. Because Extole exposes a large set of actions, short concrete asks such as 'find this Extole user by status' work better than long paragraphs.

### Does connecting Extole give the AI access to everything in my program?

No. Every call to Extole runs under the access of the person who signed in to Elaichi, so an agent can only reach what that person's Extole account can reach. Elaichi can narrow that further with toolboxes and restrictions, and it never widens it.

### Can my team share one Extole connection?

Yes. One person connects Extole with the API key and shares the connection with a team in Elaichi, and nobody else ever handles the key. Each teammate still signs in to Elaichi as themselves, so the audit log names the person behind every Extole action.

### Can I stop an agent from deleting or changing things in Extole?

Yes. Restrictions in Elaichi apply per action, so you can allow reading Extole users and audiences while blocking deleting users, removing client domains, or bulk deleting components. A blocked action is never advertised to Claude, ChatGPT, Cursor, or any other client, so no prompt can reach it.

### What happens to an Extole connection when someone leaves?

Offboarding the person in Elaichi ends their access to Extole through every client at once. If they connected a shared Extole account, that connection keeps working for everyone else it was shared with. Disconnecting Extole once in Elaichi removes it from Claude, ChatGPT, Cursor, and every other client.

## All 340 Extole tools

Every tool below is callable through https://api.elaichi.ai/mcp once Extole is connected, subject to the toolbox it is in and the restrictions on the caller.

- **Create a Extole pet** (Create). Create a new pet in the Extole store. Returns the created pet object including id, name, and status.
- **Extole pets find by status** (Action). Find pets in the Extole store by status. Multiple status values can be provided as comma-separated strings. Returns an array of pets with id, name, status, and tags. Required: status.
- **List all Extole store inventories** (List). List store inventory in Extole, returning a map of pet status codes to their available quantities. Returns: available, pending, sold as keys, each mapped to an integer count.
- **Create a Extole store order** (Create). Place a new store order in Extole. Returns the created order including its id. A request body conforming to the Order schema is required.
- **Create a Extole user create with list** (Create). Create a list of users in Extole from an input array of user objects. Returns an empty response on success. Required: a request body containing an array of user objects with username, email, and other profile fields.
- **List all Extole users** (List). List Extole staff user accounts with access to the console. Returns: id. Use the optional scope parameter to restrict results to the current account or retrieve all accessible users.
- **Delete a Extole user by ID** (Delete). Delete an Extole staff user account by id. Returns an empty 204 response on success. Required: id.
- **Create a Extole user** (Create). Create a new Extole staff user account with console access. Returns the created user including its server-assigned id, email, first_name, last_name, and scopes. An invitation email is sent to the new user.
- **Extole users attach subscription** (Action). Create a new notification subscription for an Extole user, specifying the delivery channel (email, Slack, or webhook) and optional filter expression. Returns: id, channels, dedupe_duration_ms, filter_expression, filtering_level, having_all_tags. Required: user_id.
- **Extole users unlock** (Action). Unlock a staff user account in Extole that has been locked due to failed login attempts, restoring console access. Returns: success. Required: user_id.
- **List all Extole audiences** (List). List Extole audience definitions sorted by creation date, newest first. Returns: id, name, created_at. Archived audiences are excluded by default; pass include_archived=true to include them.
- **List all Extole audiences builts** (List). List built (rendered) audience snapshots in Extole that the runtime evaluates against during targeting. Returns: id, name. Filter by name with a trailing `*` wildcard, by enabled state (ENABLED, DISABLED, ANY), or by archived status.
- **List all Extole view details** (List). List detailed profiles for all current members of an Extole audience. Returns: person_id, email, partner_user_id, data_attributes. Required: audience_id.
- **List all Extole operation states** (List). Get the current state of an Extole audience operation, including progress counters and any error details. Required: audience_id, operation_id.
- **List all Extole state debugs** (List). Get the debug state of an Extole audience operation, including internal processing information. Returns the debug state object with schema-specific fields not enumerated in the source. Required: audience_id, operation_id. Restricted to client superusers.
- **Create a Extole client domain** (Create). Create a new client domain in Extole. Returns the created client domain including id, name, domain, cname_target, proxy, redirect_client_domain_id, share_uri, ssl_certificate, ssl_certificate_chain, ssl_generation_policy, and ssl_private_key. SSL certificate and private key must match the domain and be signed by a valid chain; proxy mode requires a redirect_client_domain_id.
- **Get single Extole client domain by ID** (Get). Get a single Extole client domain by id. Returns the client domain including id, name, domain, cname_target, proxy, redirect_client_domain_id, share_uri, ssl_certificate, ssl_certificate_chain, ssl_generation_policy, and ssl_private_key. Required: id.
- **Delete a Extole client domain by ID** (Delete). Archive an Extole client domain by id. Returns: id, name. Required: id. Set force to true to archive a valid client domain that would otherwise be rejected.
- **List all Extole components** (List). List all components visible to the current Extole client — the reusable building blocks that campaigns assemble, such as creatives, content blocks, and sub-experiences. Returns: id, name, state, owner, in, schema. Max 1000 results per page.
- **Create a Extole component** (Create). Upload a new component bundle archive to Extole, creating a component and its sub-resources from the bundled definition. Returns: id, name, state, owner. Required: file.
- **Get single Extole component by ID** (Get). Get a single Extole component by id, optionally at a specific version. Returns the current version when no version is specified. Returns: id, name, state, owner, report_id, executor_type, format, status, user_id, created_date. Required: id.
- **Extole components bulk delete** (Delete). Delete an Extole component by id. Recursively removes the component and all its children; if the deleted component is a campaign root, the entire campaign is archived. The version parameter serves as an optimistic-lock guard. Returns: id, name, type, description, tags, display_name, state, owner, version_state, unique_id, http_status_code, code, message. Required: id, version.
- **List all Extole component diffs** (List). Diff two Extole components by comparing their versions. Returns a diff showing added, removed, and changed settings between the two component versions. Required: component_id, other_component_id.
- **List all Extole component translatable format s** (List). Download translatable component variable values from Extole for localisation. Returns format-specific content — a JSON array of BatchComponentVariableValues objects when format is json, a raw CSV text string when format is csv, or a binary XLSX spreadsheet when format is xlsx. Required: component_id, format.
- **List all Extole component assets** (List). List all file assets attached to an Extole component. Returns: id, name, description. Required: component_id.
- **Get single Extole component asset by ID** (Get). Get a single Extole component asset by id. Returns metadata for the file asset including its id, name, description, and tags. Required: component_id, id.
- **List all Extole asset builts** (List). Get the built (compiled) representation of a specific Extole component asset. Returns: id. Required: component_id, asset_id.
- **List all Extole component settings** (List). List all configuration settings for a specific Extole component. Returns: name, description, source, type. Required: component_id.
- **Extole component settings bulk update** (Update). Batch update component settings in Extole by applying a batch of setting value updates across the specified component in one request. Returns an array of updated settings including name, type, source, values, description, display_name, tags, and priority. Required: component_id.
- **List all Extole settings builts** (List). List all built (fully evaluated) component settings for an Extole component. Returns each setting's name, description, display_name, priority, source, tags, type, and values in their resolved runtime form. Required: component_id.
- **List all Extole component builts** (List). Get the fully evaluated (built) runtime form of an Extole component, with expression fields resolved. Returns the built component object with component-schema-specific fields. Required: component_id, version.
- **List all Extole component anchors** (List). List anchor details for a specific Extole component. Returns: source_element_id, target_element_id. Required: component_id, version. The version parameter uses the format /version/<value> or may be empty to target the default version.
- **List all Extole campaign summaries** (List). List Extole campaign summaries with optional filtering by program type, tags, labels, states, and archived inclusion. Returns: id, name, state.
- **Get single Extole campaign summary by ID** (Get). Get a single Extole campaign summary by id and version segment. Returns: id, name, state, report_id, executor_type, format, status, user_id, created_date. Required: id, version.
- **List all Extole campaigns** (List). List Extole campaigns for the calling client, optionally filtered by tags, reward supplier, or archive status. Returns: id, name, created_at, updated_at.
- **Create a Extole campaign** (Create). Create a new Extole campaign by importing a campaign ZIP archive previously exported via the campaigns API. The new campaign is created in DRAFT state with a server-assigned id. Returns: id, name, created_at, updated_at. Required: file.
- **Extole campaigns archive** (Archive). Archive a campaign version in Extole, moving it to archived state so it is hidden from default campaign listings while retained for reporting and recovery. Returns the campaign object including id, name, and state. Required: id, version. Use POST /v2/campaigns/{id}/unarchive to restore an archived campaign to active state.
- **Extole campaigns publish** (Publish). Publish an Extole campaign version, validating and building all components, controllers, flow steps, and reward rules before making it live for participants. The optional request body lets callers override the publish schedule. Returns the published campaign including its id, name, state, and version. Required: id, version.
- **Extole campaigns stop** (Stop). Stop an Extole campaign version, immediately halting all active processing and participant eligibility. A stopped campaign must be republished to resume. Returns the updated campaign object including id, name, state. Required: id, version. An optional request body with a date field can defer the stop to a future time.
- **Get single Extole campaign by ID** (Get). Get an Extole campaign by id, returning the source definition for the specified campaign version. Returns: id, name, state. Omit the version segment to retrieve the latest version; use the built endpoint for the fully evaluated runtime form. Required: id.
- **List all Extole campaigns builts** (List). List Extole campaigns in their fully evaluated (built) runtime form, with all evaluatable fields resolved against current component and setting values. Returns an array of built campaign records, each including id, program_label, version, and resolved component attributes. Supports the same filtering as the standard campaigns list endpoint.
- **List all Extole campaigns deleteds** (List). List soft-deleted Extole campaigns retained for audit and recovery purposes. Returns: id, name, state, label. Deleted campaigns can be restored via the undelete endpoint.
- **List all Extole campaigns duplicatables** (List). List Extole campaigns that the calling client is permitted to duplicate, including the client's own draft and published campaigns plus any shared template campaigns. Returns an array of campaign objects with id, name, and state. Use POST /v2/campaigns/{id}/duplicate to create a copy of a returned campaign.
- **Get single Extole campaign version by ID** (Get). Get a campaign version descriptor in Extole by campaign and version id. Returns the version's state, author, and timestamps. Required: campaign_id, id.
- **List all Extole consumer debugs** (List). Debug a consumer (person) access token in Extole by value, including tokens that are expired or invalidated. Returns: type. Required: access_token.
- **List all Extole logos** (List). Get the current Extole client logo image metadata. Returns: id, fileName, size.
- **Extole logos bulk delete** (Delete). Archive the current Extole client logo, removing it from active use. Returns: id.
- **List all Extole logo images** (List). Download the Extole client logo as a PNG image binary. Returns the raw PNG image binary data.
- **List all Extole promotion links** (List). List all Extole promotion links for the client. Promotion links are the short URLs that participants share to drive referrals. Returns: id, code, content, data, description, key, label, program_url, report_id, name, executor_type, format, status, user_id, created_date.
- **List all Extole manual coupon coupons** (List). Download the current coupon pool for an Extole manual coupon supplier as a JSON response. Returns: type. Required: reward_supplier_id. Max fetch size is 1000 records.
- **Create a Extole manual coupon coupon** (Create). Upload a coupon code file (CSV or text) to an Extole manual coupon supplier's pool. Returns: filename, type. Required: reward_supplier_id, file. Concurrent uploads are not allowed.
- **Extole manual coupon coupons bulk delete** (Delete). Delete manual coupons from an Extole manual coupon supplier's pool, optionally targeting coupons from a specific upload operation. Returns: operation_id. Required: reward_supplier_id.
- **List all Extole manual coupon operations** (List). List manual coupon operations for an Extole reward supplier, returning a log of recent upload and delete operations. Returns: operation_id, filename. Required: reward_supplier_id. Max fetch size 1000.
- **List all Extole salesforce coupon operations** (List). List recent Salesforce sync operations for a coupon supplier in Extole. Returns: created_at, updated_at. Required: reward_supplier_id. Max 1000 records per request.
- **List all Extole tango catalogs** (List). List available Tango gift card brands and denominations from the Tango Card API in Extole. Returns an array of Tango brand objects, each with an id and brand-specific attributes including denomination information.
- **List all Extole security keys** (List). List active (non-archived) Extole client security keys, optionally filtered by tags. Returns: id, name, type, description. A key is returned only when it includes every supplied tag.
- **Delete a Extole security key by ID** (Delete). Archive an Extole client security key by id so it no longer appears in list results or can be selected for new use. Returns: id, name, type, description. Required: id. Fails when the key is still referenced by campaign components or other platform resources.
- **Create a Extole timeline entry** (Create). Create a new named milestone in the Extole campaign timeline visible in the console. Returns the created entry including its server-assigned name, date, description, and tags. Required: name, date.
- **Get single Extole timeline entry by ID** (Get). Get a campaign timeline entry in Extole by id. Returns the entry including its name, date, description, and tags. Required: id.
- **Extole timeline entries bulk delete** (Delete). Delete an Extole campaign timeline entry by name. Returns the deleted entry including name, date, description, and tags. Required: name.
- **List all Extole user properties** (List). List all per-user property overrides for a staff user in Extole. Returns: name. Required: user_id.
- **Create a Extole user property** (Create). Create a new per-user property override for a staff user in Extole. Returns the created property including name and value. Required: user_id, name, value.
- **Extole user properties bulk update** (Update). Update the value of an existing per-user property override for a staff user in Extole. Returns the updated property including name and value. Required: user_id, name, value.
- **Extole user properties bulk delete** (Delete). Delete a per-user property override for a staff user in Extole. Returns: success. Required: user_id, name.
- **Get single Extole shareable by ID** (Get). Get a shareable link by code in Extole, including the participant and campaign context resolved at runtime. Returns: content. Required: id.
- **Extole shareables get legacy** (Get). Get a single Extole shareable by shareable_id for the authenticated consumer (legacy v4). Returns: id, code, content, data, key, label, share_url, target_url, report_id, name, executor_type, format, status, user_id, created_date. Required: shareable_id. Deprecated; use the v6 get-by-code endpoint instead.
- **Extole shareables get by code** (Get). Get a shareable by its ID in Extole (legacy v4 endpoint, deprecated). Returns: id, code, key, label, target_url, content, data, report_id, name, executor_type, format, status, user_id, created_date. Required: shareable_id.
- **List all Extole email domains** (List). List all custom sending domains configured for the client in Extole. Returns: id, domain, force_send_from_email_domain, dkim_cname_records, report_id, name, executor_type, format, status, user_id, created_date.
- **Create a Extole email domain** (Create). Create a new custom sending domain in Extole for campaign emails. DNS verification records are generated automatically. Returns: id, domain, force_send_from_email_domain, dkim_cname_records. Required: domain.
- **Update a Extole optout by ID** (Update). Update the opt-out suppression state for a person in Extole by secure email. Returns: email, optout, list_name, list_type, source, type. Required: secure_email, list_name, list_type, optout, source, type.
- **List all Extole reports** (List). List Extole report runs visible to the authenticated client, optionally filtered by report type, status, tags, and search query. Returns: report_id, name, executor_type, format, status, user_id, visible, source, created_date, started_date, completed_Date, error_code, dounload_url. Max 1000 per page.
- **Create a Extole report** (Create). Create a new Extole report run for the specified report type and parameters. The report executes asynchronously; poll the returned report_id to check status. Returns: name, format. Required: report_type.
- **Get single Extole report by ID** (Get). Get a single Extole report run by id, returning its current status and run metadata. Returns: completed_date, display_name, download_uri, formats, name, report_id, report_type, tags, executor_type, format, status, user_id, visible, source, created_date, started_date, completed_Date, error_code, dounload_url. Required: id.
- **Update a Extole report by ID** (Update). Update the display name, scopes, tags, or visibility of a pending Extole report run by id. Returns: format, visible, name. Required: id.
- **Extole reports cancel** (Cancel). Cancel a pending or in-progress Extole report run by its report ID. Returns: format. Required: report_id.
- **Extole reports bulk delete** (Delete). Bulk delete reports belonging to a scheduled Extole report runner. Returns an array of deleted report objects including report_id, name, status, format, and created_date. Required: report_runner_id.
- **List all Extole reports tags** (List). List report tags available for filtering reports in Extole. Returns an array of tag name strings. Optional filters: having_any_tags and exclude_having_any_tags.
- **List all Extole latest download format s** (List). Download the most recent completed report output from Extole, with optional tag filters and ordering. Returns the report file content in the requested format (CSV, JSON, JSONL, XLSX, PSV, or headless variants).
- **List all Extole report download format s** (List). Download the output of a completed Extole report run as a file in the requested format. Returns the report data as a downloadable file (CSV, JSON, JSONL, XLSX, or PSV). Required: report_id.
- **List all Extole tokens manageds** (List). List all managed API access tokens for the Extole client. Returns: id, name, scopes, duration_seconds.
- **Delete a Extole tokens managed by ID** (Delete). Delete a managed API access token in Extole by id. Returns an empty 200 response on success. Required: id.
- **List all Extole event streams** (List). List event-stream subscriptions configured for the client in Extole. Event streams push a filtered view of client-event activity to a downstream consumer such as a webhook or Kafka topic. Returns: id, name, description.
- **Get single Extole event stream by ID** (Get). Get a single Extole event-stream subscription by id. Returns: id, name. Required: id.
- **Delete a Extole event stream by ID** (Delete). Archive an Extole event-stream subscription by id, stopping event delivery without permanently removing the configuration. Returns the archived event stream including id, name, description, component_ids, component_references, stop_at, tags, and archived. Required: id.
- **List all Extole event streams builts** (List). List built event streams in Extole. Returns the evaluated runtime configuration for all event-stream subscriptions of the client, reflecting component inheritance and dynamic overrides applied at runtime. Returns: id, name, description.
- **List all Extole event stream filters** (List). List all filter rules configured on a specified Extole event stream. Returns: id, type. Required: event_stream_id.
- **Create a Extole event stream filter** (Create). Create a new filter rule on an Extole event stream to restrict which events are delivered to downstream consumers. Returns the created filter including id, app_types, and type. Required: event_stream_id.
- **Update a Extole event stream filter by ID** (Update). Update an Extole event stream filter by id. Only fields present in the request body are changed. Returns the updated filter including id, app_types, and type. Required: event_stream_id, id.
- **Delete a Extole event stream filter by ID** (Delete). Archive an Extole event stream filter by id. Returns the archived filter including id and type. Required: event_stream_id, id.
- **Get single Extole event stream filter by ID** (Get). Get a single event stream filter by id in Extole. Returns the filter rule for the specified id on the given event stream including its id, app_types, and type. Required: event_stream_id, id.
- **List all Extole jobs** (List). List all file validation monitor jobs configured for the client in Extole. Returns: id, name, enabled, tasks, triggers.
- **Get single Extole job by ID** (Get). Get a file validation monitor job in Extole by id, including its triggers and tasks. Returns: id, name. Required: id.
- **Update a Extole job by ID** (Update). Update top-level fields of a file validation monitor job in Extole by id. JobTrigger and task changes should use the sub-endpoints. Returns: id, name, enabled, tasks, triggers. Required: id, name.
- **Delete a Extole job by ID** (Delete). Soft-delete a file validation monitor job in Extole by id. Cascades soft-delete to its triggers and tasks. Returns: id, name. Required: id.
- **List all Extole jobs histories** (List). List Extole file validation monitor job execution history entries aggregated across all pods. Returns: id. Filter by job_id, status, start_date, or end_date.
- **Get single Extole jobs history by ID** (Get). Get a single Extole file validation monitor job execution history entry by execution chain id. Returns: id, job_id, status, start_date, end_date. Required: id.
- **Delete a Extole job task by ID** (Delete). Soft-delete an Extole job task by id; remaining order values are compacted. Returns the deleted task including id, task_type, order, expected_headers, match_mode, and on_mismatch. Required: job_id, id.
- **Get single Extole job task by ID** (Get). Get a single task within an Extole file validation job by its id. Returns: id, report_id, name, executor_type, format, status, user_id, visible, source, created_date, started_date, completed_Date, error_code, dounload_url. Required: job_id, id.
- **List all Extole job triggers** (List). List all triggers for a specific Extole job. Returns: id. Required: job_id.
- **Create a Extole job trigger** (Create). Add a trigger to a specific Extole job. Returns: id, trigger_type, match_type, pattern. Required: job_id, trigger_type. When trigger_type is FILE_NAME_MATCHES, match_type and pattern are required.
- **List all Extole notifications** (List). List recent in-portal notifications for the calling Extole user, sorted newest first. Returns: event_id, subscription_id, tags, event_time. Notifications include report completion alerts, campaign status changes, and custom client events fired via createClientEvent.
- **Get single Extole notification by ID** (Get). List in-portal notifications for a specific Extole portal user by id, sorted newest first. Returns: event_id, subscription_id, tags, event_time. Required: id.
- **List all Extole notifications reads** (List). Get the calling user's Extole notification read cursor — the timestamp up to which they have read their notifications. Notifications created after the returned timestamp are considered unread. Returns: report_id, name, executor_type, format, status, user_id, visible, source, created_date, started_date, completed_Date, error_code, dounload_url.
- **Update a Extole notifications read by ID** (Update). Advance the calling user's Extole notification read cursor to the supplied timestamp, marking all notifications created at or before that time as read. Returns the updated cursor state. Returns: last_read_event_time. Required: last_read_event_time.
- **List all Extole notifications snoozes** (List). List all active notification snooze rules for the calling portal user in Extole, sorted newest first. Returns: id, comment, expires_at, having_exactly_tags.
- **Create a Extole notifications snooze** (Create). Create a notification snooze rule in Extole that suppresses portal notifications matching the supplied tags until the expires_at timestamp. Returns: id, comment, expires_at, having_exactly_tags. Required: expires_at, having_exactly_tags.
- **Get single Extole notifications snooze by ID** (Get). Get a notification snooze rule by id in Extole for the calling portal user. Returns: id. Required: id.
- **List all Extole notification reads** (List). Get the Extole notification read cursor for a user, indicating the timestamp up to which their notifications have been read. Returns: last_read_event_time. Required: user_id.
- **List all Extole report types recommendations** (List). List recommended Extole report types ranked by relevance for immediate execution. Returns each report type's id, display_name, description, formats, parameters, scopes, visibility, and tags. Defaults to 5 results; maximum fetch size 1000.
- **Get single Extole reward supplier by ID** (Get). Get a single reward supplier configuration from Extole by id. Returns: id, description, name, partner_reward_supplier_id, type. Required: id.
- **Delete a Extole reward supplier by ID** (Delete). Archive a reward supplier in Extole by id, removing it from active use. Returns the archived supplier including id, name, reward_supplier_type, enabled, and other configuration fields. Required: id.
- **List all Extole reward supplier builts** (List). Get the fully evaluated (built) runtime form of a specific reward supplier in Extole. Returns: id, type, partner_reward_supplier_id, created_at, updated_at. Required: reward_supplier_id.
- **List all Extole subscriptions** (List). List all notification subscriptions for the calling Extole client, optionally filtered by tags. Returns: id. Use having_any_tags to match subscriptions with at least one of the specified tags, or having_all_tags to require all specified tags.
- **Update a Extole user subscription by ID** (Update). Update an Extole user notification subscription by id. Returns the updated subscription including id, channels, dedupe_duration_ms, filter_expression, filtering_level, and having_all_tags. Required: user_id, id.
- **Delete a Extole user subscription by ID** (Delete). Delete an Extole user notification subscription by id. The user will no longer receive notifications for the subscribed event type via that channel. Returns: success. Required: user_id, id.
- **Get single Extole user subscription by ID** (Get). Get a specific Extole user notification subscription by id. Returns: id, channels, dedupe_duration_ms, filter_expression, filtering_level, having_all_tags, report_id, name, executor_type, format, status, user_id, created_date. Required: user_id, id.
- **Update a Extole webhook by ID** (Update). Partially update an Extole webhook by id; only fields present in the body are changed and omitted fields are left intact. Returns the updated webhook with id, name, type, enabled, url, description, tags, request, and retry_intervals. Required: id.
- **List all Extole webhook builts** (List). Get the fully evaluated (built) runtime form of a specific Extole webhook by webhook_id, with all evaluatable fields resolved into their effective runtime values. Returns: id, name, type, url, description. Required: webhook_id. Returns 400 webhook_not_found if the id does not exist or is not accessible.
- **Update a Extole report runner by ID** (Update). Update an existing Extole report runner by id with a partial body — only supplied fields are changed, omitted fields are left intact. Returns the updated report runner including id, name, type, report_type, formats, and enabled. Required: id. Locked runners must be updated via deployment tooling.
- **Delete a Extole report runner by ID** (Delete). Delete an Extole report runner by id, permanently removing it and cancelling all pending executions. Returns the deleted report runner record including id, name, type, and report_type. Required: id. Locked runners cannot be deleted via the REST API.
- **Extole report runners duplicate** (Duplicate). Duplicate an Extole report runner by copying an existing one and applying body overrides; fields absent from the body are copied from the source. Returns: id, component_ids, component_references, deliver_empty_reports_to_sftp, enabled, execution_policy, expiration_ms, formats, merging_configuration, name, pause_info, report_name_pattern, report_type, scopes, sftp_report_name_pattern,…
- **List all Extole report runners templates** (List). List Extole report runner templates — pre-configured runner definitions that can be duplicated to create new runners with minimal configuration. Returns: id, name, type, report_id, executor_type, format, status, user_id, created_date.
- **Delete a Extole audience delete by ID** (Delete). Hard-delete an Extole audience permanently. Unlike archiving, deletion is irreversible; the audience must be detached from any campaign-controller membership trigger, controller action, or component variable before deletion can succeed. Returns: id, name. Required: audience_id.
- **Create a Extole client domain validate** (Create). Validate an Extole client domain by its id, triggering a validation of the domain's configuration. Returns a client domain validation response including its id and validation result attributes. Required: client_domain_id.
- **Create a Extole rename** (Create). Rename an Extole campaigns program label, applying the change across all campaigns that use it. Returns: success. Required: program_label (path), program_label (body).
- **Create a Extole campaign discard** (Create). Discard the draft version of an Extole campaign, reverting it to the last published state and losing uncommitted changes. Returns: id, name, state, description, program_label. Required: campaign_id, version.
- **Create a Extole campaign launch burst** (Create). Launch an Extole campaign version in burst mode, a high-throughput live state for time-limited promotional surges. Validates all campaign components and reward rules before the transition. Returns the updated campaign including id, name, state, start_date, and stop_date. Required: campaign_id, version. The version parameter follows the pattern /version/{version}; supply an empty string to target…
- **Create a Extole campaign launch test** (Create). Launch an Extole campaign in test mode, transitioning the specified campaign version into a limited test rollout to test participants without affecting production traffic. Validates all campaign components, controllers, and reward rules before the transition. Returns the updated campaign including id, name, state, and dates. Required: campaign_id, version. The request body accepts an optional…
- **Create a Extole campaign make latest draft** (Create). Promote a specified Extole campaign version to the latest draft, replacing any existing latest-draft pointer. Returns the updated campaign object including its id, name, state, and version. Required: campaign_id, version. The campaign must be in a state that permits draft promotion.
- **Create a Extole campaign make latest published** (Create). Promote a specified Extole campaign version to be the latest published version, replacing the existing latest-published pointer without a full publish cycle. Returns: id, state, version. Required: campaign_id, version. The campaign must already be in published state.
- **Create a Extole campaign schedule** (Create). Schedule a future state transition (e.g. go-live or end) for a published Extole campaign version at the datetimes specified in the request body. Returns the updated campaign object including its id, state, start_date, and stop_date. Required: campaign_id, version. The campaign must be published before scheduling; this replaces any existing schedule on the same version.
- **Create a Extole salesforce coupon coupon** (Create). Refill Salesforce coupons in Extole by triggering a sync that pulls new coupon codes from the Salesforce coupon pool into the supplier. Returns: operation_id. The operation runs asynchronously; poll the operations endpoint with the returned operation_id to track completion. Required: reward_supplier_id.
- **Create a Extole key unarchive** (Create). Unarchive a previously archived client key in Extole, restoring it so it can be used again. Returns the restored client key object including id, name, type, algorithm, archived, and tags. Required: key_id.
- **Create a Extole report retry** (Create). Retry a previously submitted report run in Extole by its report ID, re-running a failed or cancelled report with the same parameters. Returns the report object including report_id, name, status, format, and created_date. Required: report_id.
- **Create a Extole report shared token** (Create). Create a shared access token for an Extole report, allowing the report to be accessed without full authentication. Returns the created shared token response. Required: report_id.
- **Create a Extole event stream unarchive** (Create). Unarchive an Extole event stream, restoring a previously archived event-stream subscription and resuming event delivery. Returns the restored event stream including its id, name, description, component_ids, component_references, stop_at, and tags. Required: event_stream_id.
- **Extole updates bulk update** (Update). Update all Extole campaigns associated with a program label by applying the specified update. Returns: success. Required: program_label, program_type. The update is applied to every campaign matching the given program label.
- **Get single Extole reward by ID** (Get). Get a single Extole reward by id. Returns: reward_id, reward_supplier_id, partner_reward_supplier_id, person_id, partner_user_id, email, state, partner_reward_id, created_at. Required: id.
- **Extole rewards cancel** (Cancel). Cancel an Extole reward by reward_id, preventing fulfilment. Returns the updated reward including reward_id, state, email, and created_at. Required: reward_id.
- **List all Extole reward cancels** (List). List the cancellation history for a specific Extole reward. Returns: reward_id, reward_supplier_id, partner_reward_supplier_id, person_id, partner_user_id, email, state, partner_reward_id, created_at, cost_code, message. Required: reward_id.
- **List all Extole reward fails** (List). List the fulfilment failure history for a specific Extole reward. Returns: reward_id, reward_supplier_id, partner_reward_supplier_id, person_id, partner_user_id, email, state, partner_reward_id, created_at. Required: reward_id.
- **List all Extole reward fulfillments** (List). List fulfillment records for a specific Extole reward. Returns: reward_id, reward_supplier_id, partner_reward_supplier_id, person_id, partner_user_id, email, partner_reward_id, state, created_at. Required: reward_id.
- **List all Extole reward redeems** (List). List redemption records for a specific Extole reward. Returns: reward_id, reward_supplier_id, partner_reward_supplier_id, person_id, partner_user_id, email, partner_reward_id, state, created_at, cost_code, message. Required: reward_id.
- **List all Extole reward revokes** (List). List revocation records for an Extole reward by reward_id. Returns each revoked reward state record including reward_id, reward_supplier_id, person_id, email, state, created_at, message, and partner_reward_id. Required: reward_id.
- **List all Extole tokens** (List). Get the current Extole access token's metadata for the token used to authenticate the request. Returns: access_token, type, client_id, identity_id, expires_in, scopes.
- **Extole tokens get consumer** (Get). Get Extole consumer access token metadata, resolving the token from the request context. Returns: expires_in, scopes, identity_id, report_id, name, executor_type, format, status, user_id, created_date.
- **Create a Extole person** (Create). Create a new person profile in Extole outside the normal event-tracking flow. Returns the persisted record including id, identity_key_value, locale, and version. Required: identity_key_value.
- **Extole people get v 4** (Get). Get a public Extole person profile by person_id for rendering another participant's profile in a referral or social context. Returns: first_name, id, image_url, last_name, email, profile_picture_url, partner_user_id. Required: person_id.
- **List all Extole person blocks** (List). Get the block status for an Extole person, indicating whether they are blocked from participating in referral campaigns and the reason for the block. Returns: type. Required: person_id.
- **Extole person blocks bulk update** (Update). Update the block status for an Extole person. Set type to EVENTS to block event participation, REWARDS to block reward fulfilment, or NONE to remove any block. Returns: type, reason. Required: person_id, type.
- **Create a Extole datum** (Create). Create a new named data parameter for an Extole person. Returns: name, scope, value, updated_at. Required: person_id, name. Returns 400 data_already_exists if a parameter with the same name already exists; use PUT to update an existing parameter.
- **List all Extole person identity histories** (List). List the identity history for an Extole person, returning the chronological log of identity-merge and identity-link events that shaped the person's unified profile. Returns: event_type, previous_identity_key, event_date. Required: person_id.
- **List all Extole person locations** (List). List Extole person location records for a specified person, sorted by created date in descending order. Each record captures the geographic context (country, region, city) observed at the time of person interactions. Returns: created_at. Required: person_id.
- **Create a Extole person membership** (Create). Create a person audience membership in Extole by adding the specified person to an audience. Returns: audience_id, audience_name, created_at. Required: person_id, audience_id.
- **List all Extole person rewards** (List). List all rewards for a specific Extole person, sorted by created date in descending order. Returns: reward_id, reward_supplier_id, partner_reward_supplier_id, person_id, partner_user_id, email, state, face_value, campaign_id, partner_reward_id, created_at, cost_code, message, data. Supports filtering by reward state, reward type, campaign, program, and journey. Required: person_id.
- **List all Extole person shareables** (List). List all Extole person shareables for a person, sorted by created date descending. Returns: id, content, created_at. Required: person_id.
- **Create a Extole person shareable** (Create). Create a new Extole person shareable (referral link or code) for a person. Returns: id, code, key, label, program_url, content, data, created_at, name. Required: person_id.
- **List all Extole person steps** (List). List campaign flow steps for a person in Extole, sorted by event date in descending order. Returns: campaign_id, data, event_date, journey_name, program_label, step_name, id. Required: person_id.
- **List all Extole zones** (List). Fetch a rendered Extole zone by name with no targeting data, useful for static or anonymous zones from a server-rendered page or backend service. Returns the rendered zone content with creative-configuration-specific fields. Required: zone_name.
- **Extole zones render** (Action). Render an Extole zone from a server-side backend by supplying the zone name and targeting data in the request body. Returns rendered zone content (HTML, JavaScript, JSON, or plain text) whose shape varies by the zone's creative configuration. Required: zone_name.
- **Extole zones render v 6 named** (Action). Render a named Extole zone from a backend service, specifying the event name in the URL path and passing zone input data in the request body. Returns structured zone content as JSON whose shape varies by the zone's creative configuration. Required: event_name.
- **Update a Extole batch by ID** (Update). Update mutable fields of an Extole batch job by id — name, tags, and scopes. Returns the full updated job record including id, name, status, tags, and scopes. Required: id. The job must not be in a terminal state (DONE, FAILED, CANCELED, or EXPIRED); data source, event name, and column mappings are immutable after creation.
- **Extole batches cancel** (Cancel). Cancel an Extole batch job by batch_id. Only jobs in a non-terminal state (PENDING, QUEUED, IN_PROGRESS, or DISPATCHING) can be canceled. Returns the updated job record including id, name, status, success_rows, and failed_rows. Required: batch_id.
- **List all Extole files** (List). List file assets in Extole ordered by creation date descending. Returns: id, name, tags, status, review_status, size, format. Filter by name, user_id, tags, or statuses. Default page size is 100.
- **Create a Extole file** (Create). Upload a file asset in Extole with file content and optional metadata (name, tags, format). Returns: id, name, tags, status, review_status, size, format. The file enters AVAILABLE status on upload. Supported formats: CSV, PSV, JSON, JSONL, XLSX.
- **Update a Extole file by ID** (Update). Update the name and tags of a file asset in Extole by id. File content is immutable after upload; the asset must be in AVAILABLE status. Returns: id, name, tags. Required: id.
- **Delete a Extole file by ID** (Delete). Delete a file asset in Extole by id, permanently removing the record and releasing stored content. Batch jobs that already ingested the file are not affected. Returns: id, name. Required: id.
- **Get single Extole sftp destination by ID** (Get). Get a single SFTP destination connection profile in Extole by id. Returns: id, name, type. Required: id.
- **Update a Extole sftp destination by ID** (Update). Update an SFTP destination connection profile in Extole. Only fields present in the request body are changed. Returns the updated destination including id, name, type, host, username, port, dropbox_path, key_id, extole_key_id, and partner_key_id. Required: id.
- **Delete a Extole sftp destination by ID** (Delete). Delete an SFTP destination connection profile in Extole by id. Returns the deleted destination including id, name, type, host, username, port, dropbox_path, key_id, extole_key_id, and partner_key_id. Required: id.
- **Create a Extole person forward** (Create). Forward (merge) an Extole identity profile into a target identity profile, consolidating all activity and identifiers onto the target. After forwarding, the source profile is no longer independently addressable. Returns: id. Required: person_id, forward_to_profile_id.
- **Create a Extole async event** (Create). Submit a consumer event asynchronously in Extole for high-volume or bulk integrations. Returns: event_id. Person identification occurs asynchronously after the response is returned. No per-request rate limit. Required: event_name.
- **Create a Extole event** (Create). Submit a consumer event synchronously to Extole. Returns: person_id. Required: event_name. For high-volume ingestion use the async events endpoint instead.
- **Extole events create named** (Create). Submit a named consumer event synchronously to Extole with the event name in the URL path. Returns: reward_id, data. Required: event_name. The body is an open data map of event attributes.
- **Create a Extole sftp destination sync** (Create). Trigger an immediate sync of an Extole SFTP destination with its external server. Returns the updated destination including id, name, host, port, type, and username. Required: sftp_destination_id.
- **Create a Extole sftp destination validate** (Create). Validate an Extole SFTP destination connection profile without persisting any changes. Returns: valid, errors (any connectivity or configuration issues found). Required: sftp_destination_id.
- **Get single Extole share status by ID** (Get). Get the processing status of a prior share event submission in Extole by polling id. Deprecated. Returns: status. Required: id.
- **List all Extole assets** (List). List all assets attached to the authenticated consumer's profile in Extole. Assets are binary or text files such as wallet passes, QR codes, or uploaded images. Returns: id, data_type, name, tags.
- **Delete a Extole asset by ID** (Delete). Delete an asset by ID from the authenticated consumer's profile in Extole. Returns the deleted asset metadata including id, data_type, name, and tags. Required: id.
- **List all Extole asset downloads** (List). Download a person's asset by asset ID via the Extole consumer web API. Returns the binary asset content stream with the asset's stored content type, or a 302 redirect if the content is hosted remotely. Supply default_url to redirect to a fallback URL when the asset is not found. Required: person_id, asset_id.
- **Get single Extole asset download by ID** (Get). Download an asset by asset ID from the authenticated consumer's profile in Extole. Returns the binary or text asset content stream, or a 302 redirect if the content is hosted at a remote URL. Required: asset_id.
- **Extole asset downloads get web** (Get). Download an asset by asset ID via the Extole consumer web API. Returns the binary asset content stream with the asset's stored content type. Supply default_url to redirect to a fallback URL when the asset is not found. Required: asset_id.
- **Extole asset downloads list person** (List). Download a person's asset by asset ID from the Extole server API. Returns the binary or text asset content stream with the asset's stored content type, or a 302 redirect if the content is hosted remotely. Required: person_id, asset_id.
- **List all Extole audience memberships** (List). List audience memberships for the authenticated consumer in Extole, including eligibility audiences that affect program participation. Returns: audience_id, audience_name, created_at.
- **List all Extole friends** (List). List friends linked to the authenticated Extole consumer through referral relationships. This endpoint is deprecated. Returns: email, first_name, last_name, partner_user_id, profile_picture_url.
- **List all Extole journeys** (List). List journey records for the authenticated Extole consumer identified by the access token. Returns: id, type, container. No required parameters; filter by container or type (journey name) to narrow results.
- **Create a Extole parameter** (Create). Create or update multiple custom data fields on the authenticated consumer's Extole profile in a single request; omitted fields are left unchanged. Returns the updated profile parameters as a dynamic key-value object. Required: parameters, type.
- **Extole parameters bulk update** (Update). Set a single custom data parameter on the authenticated consumer's profile in Extole. Creates or updates one named parameter field. Returns: name, type, value. Required: parameter_name, type, value.
- **Get single Extole send verification email status by ID** (Get). Get the processing status of a prior verification email send in Extole by polling id. Deprecated. Returns: status. Required: id.
- **Get single Extole person profile picture URL by ID** (Get). Get a person's profile picture URL in Extole (legacy endpoint). Returns the profile picture URL as a plain text string. Required: id. Deprecated — use the non-legacy endpoint (GET /v4/persons/{personId}/profile-picture-url) instead.
- **Get single Extole shareable status by ID** (Get). Get the processing status of an asynchronous shareable creation in Extole. Returns: polling_id, status. Required: id. Deprecated — use the newer shareables endpoint instead.
- **Create a Extole send verification email** (Create). Send a profile verification email in Extole to confirm the authenticated consumer's email address. Returns: polling_id, status. Deprecated.
- **Create a Extole custom share** (Create). Submit a custom share event in Extole on behalf of an advocate. Deprecated; use event-based sharing instead. Returns: polling_id. Required: advocate_code, channel, message, recipient_email.
- **Create a Extole share batch** (Create). Send referral email shares to multiple recipients in a single batch request in Extole. Deprecated — use the v6 batch endpoint instead. Returns an array of email share results, each containing a polling_id for tracking send status via the email status endpoint. Required: advocate_code, message, recipient_emails.
- **Get single Extole shareables get create or update by ID** (Get). Get, create, or update a shareable in Extole for the authenticated consumer. Returns an existing shareable, creates one if missing, or updates it in place when the request data differs. Returns: code, key, label, data, preferred_code_prefixes.
- **Get single Extole shareables get or create by ID** (Get). Get or create a shareable in Extole for the authenticated consumer, returning an existing shareable matching the request criteria or creating one if none exists. Returns: id, code, key, label, content.
- **List all Extole client domain patterns** (List). List client domain patterns in Extole, optionally filtered by client_domain_id or include_archived. Returns: client_domain_id, component_ids, component_references, id, pattern, test, type.
- **Delete a Extole client domain pattern by ID** (Delete). Archive (soft-delete) a client domain pattern by id in Extole. Archived patterns are retained but excluded from domain matching; reversible via the unarchive endpoint. Returns: client_domain_id, component_ids, component_references, id, pattern, test, type. Required: id.
- **List all Extole client domain patterns builts** (List). List built client domain patterns in Extole, returning each pattern in its fully evaluated runtime form with all BuildtimeEvaluatable fields resolved to their current string values. Returns: client_domain_id, component_ids, component_references, id, pattern, test, type.
- **Create a Extole component facet** (Create). Create a new Extole component facet (category) definition. Returns the persisted record including name, display_name, allowed_values, and created_date. Required: allowed_values, display_name, name.
- **Get single Extole component facet by ID** (Get). Get a single Extole component facet (category) by id. Returns: allowed_values, created_date, display_name, name, updated_date, report_id, executor_type, format, status, user_id. Required: id.
- **Delete a Extole component facet by ID** (Delete). Archive a component facet (category) in Extole by id. Returns the archived facet including its name, display_name, and allowed_values. Fails with 400 facet_associated_with_components if the facet is still assigned to active components — remove those associations first. Required: id.
- **List all Extole component grants** (List). List all component grants for the current Extole client. Returns: client_id, component_path, grant_id, granted_date, subscription_mode, id, created_at, report_id, name, executor_type, format, status, user_id, created_date.
- **Create a Extole component grant** (Create). Grant an Extole client permission to use a specified shared component. Returns: client_id, component_path, grant_id, granted_date, subscription_mode, id, created_at, unique_id, http_status_code, code, message.
- **Delete a Extole component grant by ID** (Delete). Revoke a previously granted component permission in Extole by deleting the component grant. Returns: client_id, component_path, grant_id, granted_date, subscription_mode, id, created_at. Required: id.
- **List all Extole component subscriptions** (List). List all component subscriptions for the current Extole client. Returns: client_id, component_ids, component_path, component_references, subscribed_date, subscription_id. The full response shape is defined by the upstream ComponentSubscriptionResponse schema.
- **List all Extole component subscriptions builts** (List). List all built (evaluated) component subscriptions in Extole. Returns an array of component subscription objects in their fully evaluated runtime form, each including its id.
- **List all Extole component subscriptions subscribers** (List). List the clients subscribed to a shared component in Extole, returning an array of subscriber objects. Returns: client_id, component_ids, component_references, subscribed_date, subscription_id, attributes, report_id, name, executor_type, format, status, user_id, created_date.
- **Create a Extole component type** (Create). Create a new Extole component type definition and return the persisted record. Returns: created_date, display_name, name, parent, schema, updated_date, archived, facets. This endpoint is marked expert — typically managed by Extole staff. Required: name, schema.
- **Get single Extole component type by ID** (Get). Get a single Extole component type by id. Returns: created_date, display_name, name, parent, schema, updated_date, archived, facets. Returns 400 component_type_not_found if the name does not match any accessible type. Required: id.
- **Update a Extole component type by ID** (Update). Apply a partial update to an Extole component type by id. Returns: created_date, display_name, name, parent, schema, updated_date, archived, facets. Returns 400 component_type_not_found if the name does not match any accessible type. Required: id.
- **Get single Extole extended core by ID** (Get). Get a single JavaScript SDK core extension by id in Extole. Returns the source definition including id, enabled, source_code, and component_references. Required: id.
- **Delete a Extole extended core by ID** (Delete). Archive (soft-delete) a JavaScript SDK core extension by id in Extole. The extension is removed from the SDK core loader immediately but its definition is retained. Returns the archived extended core including id, enabled, source_code, and component_references. Required: id.
- **List all Extole extended cores builts** (List). List all built (fully evaluated) JavaScript SDK core extensions in Extole, with evaluatable fields resolved to their current runtime values. Returns built extended core objects with schema-specific evaluated runtime fields. Set include_archived=true to include archived extensions.
- **List all Extole campaign controllers** (List). List all controllers for an Extole campaign, optionally filtered by type. Returns: id, name, type.
- **Create a Extole campaign controller** (Create). Create a new controller in an Extole campaign. Controllers orchestrate campaign logic by combining triggers with actions. Returns the created controller with id, name, type, enabled, and scope.
- **Extole campaign controllers approves** (Action). Create an approve action on an Extole campaign controller. When triggers fire, this action approves the participant's pending step or reward. Returns: action_id, action_type, component_ids, component_references, enabled, quality, cause_type, event_type, force, legacy_action_id, note, partner_event_id, polling_id, polling_name, reward_tags, id. Required: controller_id.
- **Extole campaign controllers cancel rewards** (Cancel). Create a cancel-reward action on an Extole campaign controller. When the controller's triggers fire, the action cancels the specified reward for the participant. Returns: action_id, action_type, component_ids, component_references, enabled, quality, message, reward_id, id. Required: controller_id.
- **Extole campaign controllers create memberships** (Create). Create a create-membership action on an Extole campaign controller. When the controller's triggers fire, the action adds the participant to the specified audience. Returns: action_id, action_type, component_ids, component_references, enabled, quality, audience_id, id. Required: controller_id.
- **Extole campaign controllers declines** (Action). Create a decline action on an Extole campaign controller. When the controller's triggers fire, the action declines the participant's pending step or reward in the journey. Returns: action_id, action_type, component_ids, component_references, enabled, quality, cause_type, event_type, legacy_action_id, note, partner_event_id, polling_id, polling_name, id. Required: controller_id.
- **Extole campaign controllers earn rewards** (Action). Create an earn-reward action on an Extole campaign controller. When the controller's triggers fire, this action issues a new reward through the configured reward supplier. Returns the created earn-reward action including its server-assigned id, enabled, quality, reward_name, reward_supplier_id, slots, and tags. Required: controller_id.
- **Extole campaign controllers emails** (Action). Create an email action on an Extole campaign controller. When the controller's triggers fire, this action sends the configured email to the participant. Returns the created email action including its server-assigned id, enabled, quality, and zone_name. Required: controller_id.
- **Extole campaign controllers incentivizes** (Action). Create an incentivize action on an Extole campaign controller. When the controller's triggers fire, this action issues an incentive (coupon, gift card, payout, etc.) to the participant. Returns: action_id, action_type, component_ids, component_references, enabled, quality, action_name, data, incentivize_action_type, overrides, review_status, id. Required: controller_id.
- **Extole campaign controllers remove memberships** (Delete). Create a remove-membership action on an Extole campaign controller. When the controller's triggers fire, this action removes the participant from the specified audience. Returns: action_id, action_type, component_ids, component_references, enabled, quality, audience_id, id. Required: controller_id.
- **Extole campaign controllers step signals** (Action). Create a step-signal action on an Extole campaign controller that fires a step-scoped signal advancing the participant within a flow step. Returns: action_id, action_type, component_ids, component_references, enabled, quality, name, polling_id, id. Required: controller_id.
- **Extole campaign controllers data intelligences v 2** (Action). Create a data-intelligence action on an Extole campaign controller. When the controller's triggers fire, the action sends participant event data to the Data Intelligence pipeline for ML scoring. Returns: id, component_ids, component_references, enabled, event_name, intelligence_provider, profile_risk_update_interval, quality. Required: campaign_id, version.
- **List all Extole controllers builts** (List). List built campaign controllers in Extole, returning all controllers in their fully evaluated runtime form with expression fields resolved. Returns: id, name, type, description.
- **Get single Extole controller action by ID** (Get). Get a campaign controller action. Required: id, controller_id.
- **List all Extole actions approves** (List). Get an Extole approve action configuration for a specific action on a campaign controller. Returns: action_id, action_type, component_ids, component_references, enabled, quality, cause_type, event_type, force, legacy_action_id, note, partner_event_id, polling_id, polling_name, reward_tags, id. Required: controller_id, action_id.
- **List all Extole actions cancel rewards** (List). Get a cancel-reward action configuration in Extole by action id. Returns: action_id, action_type, component_ids, component_references, enabled, quality, message, reward_id, id. Required: controller_id, action_id.
- **Delete a Extole actions cancel reward by ID** (Delete). Delete a cancel-reward action from an Extole campaign controller. Returns the deleted action record including its id, enabled, reward_id, message, quality, component_ids, and component_references. Required: id, controller_id.
- **List all Extole actions create memberships** (List). Get a create-membership action configuration in Extole by its action id on a campaign controller. Returns: action_id, action_type, component_ids, component_references, enabled, quality, audience_id, id. The version parameter follows the pattern (/version/.+) and may be empty. Required: controller_id, action_id.
- **Update a Extole actions create membership by ID** (Update). Update a create-membership action in Extole on a campaign controller. Only fields present in the request body are changed. Returns: action_id, action_type, component_ids, component_references, enabled, quality, audience_id, id. The version parameter follows the pattern (/version/.+) and may be empty. Required: id, controller_id.
- **Delete a Extole actions create membership by ID** (Delete). Delete a create-membership action from a campaign controller in Extole. Returns the deleted action record including id, audience_id, component_ids, component_references, enabled, quality. The version parameter follows the pattern (/version/.+) and may be empty. Required: id, controller_id.
- **Create a Extole actions creative** (Create). Upload a creative archive zip to a creative action on an Extole campaign controller. Returns the updated creative action including id, api_version, classification, enabled, quality. Required: controller_id, action_id.
- **Update a Extole actions creative by ID** (Update). Update a creative action on an Extole campaign controller; only fields present in the request body are changed. Returns the updated action including id, api_version, classification, enabled, quality. Required: id, controller_id.
- **Extole actions creatives download** (Download). Download the creative archive ZIP file for a specific creative action on an Extole campaign controller. Returns the creative archive as a binary ZIP file. Required: controller_id.
- **Update a Extole actions data intelligence by ID** (Update). Update a data-intelligence action on an Extole campaign controller. Only fields present in the request body are changed. Returns: action_id, action_type, component_ids, component_references, enabled, quality, event_name, intelligence_provider, profile_risk_update_interval, id. Required: id, controller_id.
- **Update a Extole actions decline by ID** (Update). Update a decline action on a campaign controller in Extole. Only fields present in the request body are changed. Returns: action_id, action_type, component_ids, component_references, enabled, quality, cause_type, event_type, legacy_action_id, note, partner_event_id, polling_id, polling_name, id. Required: id, controller_id.
- **Update a Extole actions earn reward by ID** (Update). Update an earn-reward action on an Extole campaign controller; only fields present in the request body are changed. Returns: action_id, action_type, component_ids, component_references, enabled, quality, data, event_time, extra_data, reward_action_id, reward_name, reward_supplier_id, slots, tags, value_of_event_being_rewarded, id, polling_id, program_domain_id, sandbox. Required: id, controller_id.
- **Update a Extole actions expression by ID** (Update). Update an expression action on an Extole campaign controller. Only fields present in the request body are changed. Returns: action_id, action_type, component_ids, component_references, enabled, quality, data, expression, id. Required: id, controller_id.
- **Delete a Extole actions expression by ID** (Delete). Delete an expression action from an Extole campaign controller. Returns the deleted action record including id, enabled, expression, quality, component_ids, component_references, and data. Required: id, controller_id.
- **Update a Extole actions fulfill reward by ID** (Update). Update a fulfill-reward action on an Extole campaign controller; only fields present in the body are changed. Returns: action_id, action_type, component_ids, component_references, enabled, quality, event_time, message, partner_reward_id, reward_id, success, id, amount. Required: id, controller_id.
- **List all Extole actions redeem rewards** (List). Get a redeem-reward action configuration in Extole by action id. Returns: action_id, action_type, component_ids, component_references, enabled, quality, data, event_time, partner_event_id, reward_id, id. Required: controller_id, action_id.
- **Delete a Extole actions redeem reward by ID** (Delete). Delete a redeem-reward action from an Extole campaign controller. Returns the deleted action record including id, reward_id, enabled, quality, event_time, partner_event_id, component_ids, component_references, data. Required: id, controller_id.
- **List all Extole actions remove memberships** (List). Get a remove-membership action configuration on an Extole campaign controller by action id. Returns: action_id, action_type, component_ids, component_references, enabled, quality, audience_id, id. Required: controller_id, action_id.
- **Update a Extole actions revoke reward by ID** (Update). Update a revoke-reward action on an Extole campaign controller; only fields present in the request body are changed. Returns: action_id, action_type, component_ids, component_references, enabled, quality, message, reward_id, id. Required: id, controller_id.
- **Delete a Extole actions revoke reward by ID** (Delete). Delete a revoke-reward action from an Extole campaign controller. Returns the deleted action record including component_ids, component_references, enabled, message, quality, reward_id, and id. Required: id, controller_id.
- **Delete a Extole actions schedule by ID** (Delete). Delete a schedule action from an Extole campaign controller. Returns the deleted action record including id, schedule_name, enabled, dates, delays, quality, component_ids, and component_references. Required: id, controller_id.
- **List all Extole actions share events** (List). Get a share-event action configuration in Extole for a specific action id on a campaign controller. Returns: action_id, action_type, component_ids, component_references, enabled, quality, id. Required: controller_id, action_id.
- **Delete a Extole actions share event by ID** (Delete). Delete a share-event action in Extole from a campaign controller. Returns the deleted action record including id, component_ids, component_references, enabled, quality. Required: id, controller_id.
- **Update a Extole actions signal by ID** (Update). Update a signal action on an Extole campaign controller; only fields present in the request body are changed. Returns: action_id, action_type, component_ids, component_references, enabled, quality, data, signal_polling_id, id. Required: id, controller_id.
- **Update a Extole actions step signal by ID** (Update). Update a step-signal action on a campaign controller in Extole. Only fields present in the request body are changed. Returns: action_id, action_type, component_ids, component_references, enabled, quality, polling_id, id. Required: id, controller_id.
- **Update a Extole actions webhook by ID** (Update). Update a webhook action on an Extole campaign controller. Only fields present in the request body are changed. Returns: action_id, action_type, component_ids, component_references, enabled, quality, data, webhook_id. Required: id, controller_id.
- **Delete a Extole actions webhook by ID** (Delete). Delete a webhook action from an Extole campaign controller. Returns the deleted action record including id, enabled, quality, webhook_id, component_ids, and data. Required: id, controller_id.
- **Update a Extole actions display by ID** (Update). Update a display action on an Extole campaign controller. Only fields present in the request body are changed. Returns: action_id, action_type, component_ids, component_references, enabled, quality, body, headers, response, id. Required: id, controller_id.
- **List all Extole display builts** (List). Get the built (fully evaluated) display action for an Extole campaign controller, with all expression fields resolved at runtime. Returns: action_id, action_type, component_ids, component_references, enabled, quality, body, headers, response, id. Required: controller_id, action_id.
- **List all Extole actions emails** (List). Get an email action configuration from an Extole campaign controller by action id. Returns: action_id, action_type, component_ids, component_references, enabled, quality, data, zone_name, id. The version parameter follows the pattern (/version/.+)? and may be empty to target the default campaign version. Required: controller_id, action_id.
- **Update a Extole actions email by ID** (Update). Update an email action on an Extole campaign controller. Only fields present in the request body are changed. Returns: action_id, action_type, component_ids, component_references, enabled, quality, data, zone_name, id. Required: id, controller_id.
- **Delete a Extole actions email by ID** (Delete). Delete an email action from an Extole campaign controller. Returns the deleted email action record including id, component_ids, component_references, data, enabled, quality, and zone_name. Required: id, controller_id.
- **List all Extole email builts** (List). Get the fully evaluated (built) runtime form of an Extole campaign controller email action, with all expression fields resolved. Returns: action_id, action_type, component_ids, component_references, enabled, quality, data, zone_name, id. Required: controller_id, action_id.
- **Update a Extole actions fire as person by ID** (Update). Update a fire-as-person action on an Extole campaign controller; only fields present in the request body are changed. Returns: action_id, action_type, component_ids, component_references, enabled, quality, as_person_identification, as_person_journey, data, event_name, event_time, extra_data, labels, person_id, id. Required: id, controller_id.
- **Delete a Extole actions fire as person by ID** (Delete). Delete a fire-as-person action from an Extole campaign controller. Returns the deleted action record including id, enabled, event_name, quality, and as_person_identification. Required: id, controller_id.
- **List all Extole fire as person builts** (List). Get the fully evaluated (built) runtime form of a fire-as-person campaign controller action in Extole, with all expression fields resolved. Returns: action_id, action_type, component_ids, component_references, enabled, quality, as_person_identification, as_person_journey, data, event_name, event_time, extra_data, labels, person_id. The…. Required: controller_id, action_id.
- **Delete a Extole actions incentivize status update by ID** (Delete). Delete an incentivize-status-update action from an Extole campaign controller. Returns the deleted action record including id, enabled, event_type, quality, message, move_to_pending. Required: id, controller_id.
- **List all Extole actions incentivizes** (List). Get an Extole incentivize action configuration for a specific action on a campaign controller. Returns: action_id, action_type, component_ids, component_references, enabled, quality, action_name, data, incentivize_action_type, overrides, review_status, id. Required: controller_id, action_id.
- **Delete a Extole actions incentivize by ID** (Delete). Delete an Extole incentivize action from a campaign controller. Returns the deleted action record including id, action_name, incentivize_action_type, enabled, quality, review_status, component_ids, component_references, data, and overrides. Required: id, controller_id.
- **List all Extole incentivize builts** (List). Get the built incentivize action. Returns: action_id, action_type, component_ids, component_references, enabled, quality, action_name, data. Required: controller_id, action_id.
- **List all Extole triggers builts** (List). List built triggers on an Extole campaign controller, returning each trigger in its fully evaluated runtime form with all expression fields resolved. Returns an array of built trigger objects. Required: controller_id.
- **List all Extole triggers accesses** (List). Get an Extole access trigger configuration by trigger id on a campaign controller. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, trusted_scopes, id. Required: controller_id, trigger_id.
- **Update a Extole triggers access by ID** (Update). Update an Extole access trigger on a campaign controller; only fields present in the request body are changed. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, trusted_scopes, id. Required: id, controller_id, trusted_scopes.
- **Delete a Extole triggers access by ID** (Delete). Delete an Extole access trigger from a campaign controller. Returns the deleted trigger record including id, trigger_name, trigger_phase, enabled, negated, trusted_scopes, component_ids, component_references, parent_trigger_group_name, trigger_description. Required: id, controller_id.
- **Update a Extole triggers audience membership event by ID** (Update). Update an Extole audience membership event trigger by id. Only fields present in the request body are changed; omitted fields retain their current values. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, audience_ids, event_types, id. Required: id, controller_id.
- **List all Extole triggers audience memberships** (List). Get an Extole audience membership trigger configuration by its trigger id on a given campaign controller. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, having_any_audience_id, person_id, id. Required: controller_id, trigger_id.
- **Delete a Extole triggers audience membership by ID** (Delete). Delete an Extole audience membership trigger from a campaign controller. Returns the deleted trigger record including id, trigger_name, trigger_phase, enabled, having_any_audience_id. Required: id, controller_id.
- **Create a Extole triggers data intelligence event** (Create). Create a Data Intelligence event trigger on an Extole campaign controller. The trigger fires when a Data Intelligence scoring event matches the configured criteria. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, event_name, id. Required: controller_id, event_name.
- **Delete a Extole triggers has identity by ID** (Delete). Delete a has-identity trigger from an Extole campaign controller by id. Returns the deleted trigger record including id, trigger_name, trigger_phase, enabled, negated, trigger_description, parent_trigger_group_name, component_ids, and component_references. Required: id, controller_id.
- **Create a Extole triggers has identity** (Create). Create a has-identity trigger on an Extole campaign controller that fires when a participant has (or lacks) a configured identity attribute. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, id. Required: controller_id.
- **Update a Extole triggers has prior reward by ID** (Update). Update a has-prior-reward trigger on an Extole campaign controller; only fields present in the request body are changed. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, count_matches, count_max, count_min, filter_expression, filter_expressions, filter_face_value_types,…. Required: id, controller_id.
- **List all Extole triggers has prior steps** (List). Get a has-prior-step trigger configuration in Extole by trigger id. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, count_matches, count_max, count_min, filter_campaign_id, filter_campaign_ids, filter_expression, filter_expressions, filter_max_age, filter_max_date,…. Required: controller_id, trigger_id.
- **Delete a Extole triggers has prior step by ID** (Delete). Delete a has-prior-step trigger in Extole by id. Returns the deleted trigger record including id, trigger_name, trigger_phase, enabled, and negated. Required: id, controller_id.
- **Update a Extole triggers legacy labels targeting by ID** (Update). Update a legacy label targeting trigger in Extole. Only fields present in the request body are changed. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, id. Required: id, controller_id.
- **List all Extole triggers max minds** (List). Get a MaxMind trigger on an Extole campaign controller. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, allow_high_risk_email, default_quality_score, ip_threshold, risk_threshold, id. Required: controller_id, trigger_id.
- **Update a Extole triggers referred by event by ID** (Update). Update a referred-by-event trigger in Extole. Only fields present in the request body are changed. Returns the updated trigger including id, trigger_name, trigger_phase, referral_originator, enabled, negated, and component references. Required: id, controller_id, referral_originator.
- **Delete a Extole triggers referred by event by ID** (Delete). Delete a referred-by-event trigger from an Extole campaign controller. Returns the deleted trigger record including id, trigger_name, trigger_phase, referral_originator, enabled, and negated. Required: id, controller_id.
- **Create a Extole triggers referred by event** (Create). Create a referred-by-event trigger on an Extole campaign controller that fires when a participant was referred by another participant. Returns the created trigger including id, trigger_name, trigger_phase, referral_originator, enabled, and negated. Required: controller_id, referral_originator.
- **List all Extole triggers reward events** (List). Get a reward event trigger configuration in Extole by trigger id on a campaign controller. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, event_names, reward_states, slots, tags. Required: controller_id, trigger_id.
- **Update a Extole triggers reward event by ID** (Update). Update a reward event trigger on an Extole campaign controller. Only fields present in the request body are changed. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, event_names, reward_states, slots, tags, id. Required: id, controller_id.
- **List all Extole triggers scores** (List). Get a score trigger configuration for a specific Extole campaign controller. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, cause_event_name, channel, score_result, id. Required: controller_id, trigger_id.
- **Create a Extole triggers score** (Create). Create a new score trigger on an Extole campaign controller. The trigger fires when the computed score for the participant crosses the configured threshold. Returns the created trigger including id, trigger_name, trigger_phase, score_result, cause_event_name, enabled, negated, channel. Required: controller_id, cause_event_name, channel, score_result.
- **List all Extole triggers send reward events** (List). Get a send-reward-event trigger in Extole by its trigger id on a campaign controller. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, reward_names, reward_states, tags, id. Required: controller_id, trigger_id.
- **Update a Extole triggers send reward event by ID** (Update). Update a send-reward-event trigger on an Extole campaign controller. Only fields present in the request body are changed. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, reward_names, reward_states, tags, id. Required: id, controller_id.
- **Create a Extole triggers send reward event** (Create). Create a send-reward-event trigger on an Extole campaign controller. The trigger fires when a send-reward event is detected in the campaign pipeline. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, reward_names, reward_states, tags, id. Required: controller_id.
- **List all Extole triggers shares** (List). Get a share trigger. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name. Required: controller_id, trigger_id.
- **Delete a Extole triggers share by ID** (Delete). Delete a share trigger from an Extole campaign controller. Returns the deleted trigger record including trigger_id, trigger_name, trigger_phase, enabled, channels, share_types, and quality. Required: id, controller_id.
- **Create a Extole triggers share** (Create). Create a share trigger on an Extole campaign controller that fires when a participant performs a share action. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, channels, quality, share_types, id. Required: controller_id, channels, quality.
- **List all Extole triggers zone states** (List). Get a zone state trigger configuration by id on an Extole campaign controller. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, invert_mapping_state, step_name, zone_name, id. Required: controller_id, trigger_id.
- **Update a Extole triggers zone state by ID** (Update). Update a zone state trigger on an Extole campaign controller; only fields present in the request body are changed. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, invert_mapping_state, step_name, zone_name, id. Required: id, controller_id.
- **Create a Extole triggers zone state** (Create). Create a zone state trigger on an Extole campaign controller that fires when a zone reaches the configured display state. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, invert_mapping_state, step_name, zone_name, id. Required: controller_id.
- **Update a Extole triggers event targeting by ID** (Update). Update an event targeting trigger on an Extole campaign controller. Only fields present in the request body are changed. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, targeting_attributes, id. Required: id, controller_id.
- **Create a Extole triggers expression** (Create). Create an expression trigger on an Extole campaign controller that fires when the configured expression evaluates to true. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, data, expression, id. Required: controller_id, data, expression.
- **List all Extole group builts** (List). Get the built (fully evaluated) form of a group trigger in Extole with all expression fields resolved. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, operator, id. Required: controller_id, trigger_id.
- **Create a Extole triggers journey check** (Create). Create a journey check trigger on an Extole campaign controller. The trigger fires based on the participant's current position within the campaign journey. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, journey_name, person_id, id. Required: controller_id.
- **List all Extole triggers legacy qualities** (List). Get a legacy quality trigger configuration in Extole by trigger id. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, action_type, id. Required: controller_id, trigger_id.
- **Delete a Extole triggers legacy quality by ID** (Delete). Delete a legacy quality trigger from an Extole campaign controller. Returns the deleted trigger record including id, action_type, trigger_name, trigger_phase, enabled, negated, component_ids, component_references, parent_trigger_group_name, and trigger_description. Required: id, controller_id.
- **List all Extole legacy quality builts** (List). Get the fully evaluated (built) runtime form of a legacy quality trigger in Extole, with all expression fields resolved. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, action_type, id. Required: controller_id, trigger_id.
- **List all Extole triggers step events** (List). Get a step event trigger configuration in Extole by its trigger id on a campaign controller. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, event_names, having_any_data_name, id. Required: controller_id, trigger_id.
- **Delete a Extole triggers step event by ID** (Delete). Delete a step event trigger from an Extole campaign controller. Returns the deleted trigger record including id, trigger_name, trigger_phase, enabled, and event_names. Required: id, controller_id.
- **Create a Extole triggers step event** (Create). Create a step event trigger on an Extole campaign controller. The trigger fires on step lifecycle events (entered, completed, exited) for the participant. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, event_names, having_any_data_name, id. Required: controller_id.
- **List all Extole triggers targetings** (List). Get a targeting trigger configuration in Extole for a specific trigger id on a campaign controller. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, scope, id. Required: controller_id, trigger_id.
- **Update a Extole triggers targeting by ID** (Update). Update a targeting trigger on an Extole campaign controller. Only fields present in the request body are changed. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, scope, id. Required: id, controller_id.
- **List all Extole trigger builts** (List). Get a built campaign controller trigger by id in Extole, returning the fully evaluated runtime form of the trigger with all expression fields resolved. The version parameter follows the pattern /version/<value> and may be empty. Required: controller_id, trigger_id.
- **List all Extole campaign flow steps** (List). List all flow steps for an Extole campaign. Returns: apps, component_ids, component_references, description, flow_path, flow_step_id, icon_color, icon_type, metrics, name, sequence, step_name, tags, words, id.
- **Get single Extole campaign flow step by ID** (Get). Get a single campaign flow step in Extole by its id. Flow steps are the visual builder blocks of a participant's journey through a campaign. Returns: apps, component_ids, component_references, description, flow_path, flow_step_id, icon_color, icon_type, metrics, name, sequence, step_name, tags, words, id, report_id, executor_type, format, status, user_id, created_date. Required: id.
- **List all Extole flow steps builts** (List). List built campaign flow steps in Extole, returning all steps in their fully evaluated runtime form with expression fields resolved. Returns: apps, component_ids, component_references, description, flow_path, flow_step_id, icon_color, icon_type, metrics, sequence, step_name, tags, words.
- **List all Extole flow step builts** (List). Get the fully evaluated (built) runtime form of a campaign flow step in Extole, with expression fields resolved. Returns the built flow step including its id, name, step_name, flow_path, and sequence. The version parameter follows the pattern /version/<version> or may be empty for the default campaign version. Required: flow_step_id.
- **Delete a Extole flow step app by ID** (Delete). Delete an Extole campaign flow step app by id. Returns the deleted record including id, name, description, type, component_ids, and component_references. Required: id, flow_step_id.
- **List all Extole app builts** (List). Get a built campaign flow step app in Extole, returning the fully evaluated runtime form with expression fields resolved. Returns: component_ids, component_references, description, name, type. Required: flow_step_id, flow_step_app_id.
- **Update a Extole flow step metric by ID** (Update). Update a campaign flow step metric in Extole; only fields present in the request body are changed. Returns: component_ids, component_references, description, expression, id, tags, unit. Required: id, flow_step_id.
- **Delete a Extole flow step metric by ID** (Delete). Delete a campaign flow step metric in Extole. Returns the deleted record including id, name, expression, unit, tags, description, component_ids, and component_references. Required: id, flow_step_id.
- **Get single Extole step status by ID** (Get). Get the processing status of a step-signal operation in Extole by its polling id. Returns the step signal response including polling_id and status. Part of Extole's polling pattern for asynchronous operations that may exceed the 100ms response window. Required: id.
- **List all Extole public steps** (List). List public program steps for the authenticated consumer in Extole. Returns: campaign_id, data, event_date, journey_name, program_label, step_name. Filter by campaign_id, program_label, or step_name to narrow the result set.
- **List all Extole shares alls** (List). List all shares for the authenticated consumer in Extole. Returns every share recorded for the consumer without partner filters. Returns: campaign_id, channel, id, link, partner_id, share_date, share_id, shareable_id, partner_share_id, recipient_email, data, message, report_id, name, executor_type, format, status, user_id, created_date.
- **List all Extole tokens resources** (List). Get the resource-scoped access token associated with the current Extole credentials. Returns: access_token, expires_in, identity_id, resources.
- **Create a Extole prehandler** (Create). Create a new Extole prehandler appended to the end of the execution order. Returns: actions, component_ids, component_references, conditions, created_date, description, enabled, id, name, order, tags, updated_date. Required: name.
- **List all Extole report runners tags** (List). List all distinct tags applied to report runners in Extole. Returns an array of tag strings that can be used with tag-based filters on the report runners list endpoint. Returns: tag (distinct tag name).
- **List all Extole report runner latests** (List). Get the most recent completed report produced by an Extole report runner. Returns: completed_date, display_name, download_uri, formats, name, report_id, report_type, tags, executor_type, format, status, user_id, visible, source, created_date, started_date, completed_Date, error_code, dounload_url. Required: report_runner_id.
- **List all Extole report runner reports** (List). List reports executed by an Extole report runner, sorted by schedule date in descending order. Returns: report_id, name, executor_type, format, status, user_id, visible, source, created_date, started_date, completed_date, error_code, dounload_url. Max 1000 per page. Required: report_runner_id.
- **List all Extole report type clients** (List). List Extole client IDs that currently have access to a report type. Returns an array of client id strings. Required: report_type_id.
- **Extole report type clients bulk update** (Update). Replace the complete set of Extole clients with access to a PRIVATE report type. Returns the updated report type including id, display_name, description, parameters, formats, scopes, visibility, and tags. Only applicable to PRIVATE report types; other visibilities return an error. Required: id.
- **Create a Extole client domain pattern unarchive** (Create). Restore a previously archived Extole client domain pattern to active domain matching. Returns the restored pattern record including id, pattern, type, client_domain_id, test, and component_references. Required: client_domain_pattern_id.
- **Create a Extole component grants all** (Create). Grant a client access to all available shared components in the Extole component library. Returns: client_id, component_path, grant_id, granted_date, subscription_mode, unique_id, http_status_code, code, message.
- **Create a Extole consumer authorize** (Create). Upgrade an anonymous Extole consumer access token to an authenticated token by associating it with a verified consumer identity. Returns: access_token, client_id, scopes. Required: access_token.
- **Create a Extole consumer token** (Create). Create a consumer access token for a specific person in Extole. Returns: access_token, client_id, scopes. Required: person_id.
- **Create a Extole debug client event** (Create). Send a client event to Extole for debugging purposes. Returns the created client event including its data, level, message, name, and tags. Required: data, level, message, name, tags.
- **Create a Extole debug log** (Create). Send a log message to Extole. Returns the created log object including its level and message. Required: level, message.
- **Create a Extole email validate** (Create). Validate an email address in Extole by checking whether it is syntactically valid and acceptable for use in Extole programs without creating or updating a consumer identity. Returns: email, provider. Required: email.
- **Create a Extole report runner run** (Create). Execute an Extole report runner by its report runner id. Returns an existing in-progress report if one exists, or generates a new one otherwise. Returns: id, slot, type, status, format. Required: report_runner_id, slot.
- **Create a Extole flow exchange** (Create). Exchange an OAuth authorization code for an Extole access token using the authorization code flow. Returns: client_key_id. Required: client_key_id, code, redirect_uri.
- **Extole report type tags deletes bulk update** (Update). Remove tags from an Extole report type by supplying an array of tag names; tags not currently set are silently ignored. Returns the updated report type including id, display_name, description, parameters, formats, scopes, visibility, tags, and component_references. Required: id.