Extole MCP connector

• Create Create a Extole pet Create a new pet in the Extole store. Returns the created pet object including id, name, and status.
• Action Extole pets find by status 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 List all Extole store inventories 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 Create a Extole store order 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 Create a Extole user create with list 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 List all Extole users 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 Delete a Extole user by ID Delete an Extole staff user account by id. Returns an empty 204 response on success. Required: id.
• Create Create a Extole user 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.
• Action Extole users attach subscription 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.
• Action Extole users unlock 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 List all Extole audiences 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 List all Extole audiences builts 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 List all Extole view details List detailed profiles for all current members of an Extole audience. Returns: person_id, email, partner_user_id, data_attributes. Required: audience_id.
• List List all Extole operation states Get the current state of an Extole audience operation, including progress counters and any error details. Required: audience_id, operation_id.
• List List all Extole state debugs 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 Create a Extole client domain 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 Get single Extole client domain by ID 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 Delete a Extole client domain by ID 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 List all Extole components 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 Create a Extole component 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 Get single Extole component by ID 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.
• Delete Extole components bulk 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 List all Extole component diffs 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 List all Extole component translatable format s 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 List all Extole component assets List all file assets attached to an Extole component. Returns: id, name, description. Required: component_id.
• Get Get single Extole component asset by ID 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 List all Extole asset builts Get the built (compiled) representation of a specific Extole component asset. Returns: id. Required: component_id, asset_id.
• List List all Extole component settings List all configuration settings for a specific Extole component. Returns: name, description, source, type. Required: component_id.
• Update Extole component settings bulk 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 List all Extole settings builts 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 List all Extole component builts 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 List all Extole component anchors 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 List all Extole campaign summaries List Extole campaign summaries with optional filtering by program type, tags, labels, states, and archived inclusion. Returns: id, name, state.
• Get Get single Extole campaign summary by ID 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 List all Extole campaigns List Extole campaigns for the calling client, optionally filtered by tags, reward supplier, or archive status. Returns: id, name, created_at, updated_at.
• Create Create a Extole campaign 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.
• Archive Extole campaigns 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.
• Publish Extole campaigns 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.
• Stop Extole campaigns 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 Get single Extole campaign by ID 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 List all Extole campaigns builts 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 List all Extole campaigns deleteds 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 List all Extole campaigns duplicatables 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 Get single Extole campaign version by ID 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 List all Extole consumer debugs Debug a consumer (person) access token in Extole by value, including tokens that are expired or invalidated. Returns: type. Required: access_token.
• List List all Extole logos Get the current Extole client logo image metadata. Returns: id, fileName, size.
• Delete Extole logos bulk delete Archive the current Extole client logo, removing it from active use. Returns: id.
• List List all Extole logo images Download the Extole client logo as a PNG image binary. Returns the raw PNG image binary data.
• List List all Extole promotion links 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 List all Extole manual coupon coupons 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 Create a Extole manual coupon coupon 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.
• Delete Extole manual coupon coupons bulk 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 List all Extole manual coupon operations 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 List all Extole salesforce coupon operations 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 List all Extole tango catalogs 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 List all Extole security keys 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 Delete a Extole security key by ID 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 Create a Extole timeline entry 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 Get single Extole timeline entry by ID Get a campaign timeline entry in Extole by id. Returns the entry including its name, date, description, and tags. Required: id.
• Delete Extole timeline entries bulk delete Delete an Extole campaign timeline entry by name. Returns the deleted entry including name, date, description, and tags. Required: name.
• List List all Extole user properties List all per-user property overrides for a staff user in Extole. Returns: name. Required: user_id.
• Create Create a Extole user property 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.
• Update Extole user properties bulk 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.
• Delete Extole user properties bulk delete Delete a per-user property override for a staff user in Extole. Returns: success. Required: user_id, name.
• Get Get single Extole shareable by ID Get a shareable link by code in Extole, including the participant and campaign context resolved at runtime. Returns: content. Required: id.
• Get Extole shareables get legacy 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.
• Get Extole shareables get by code 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 List all Extole email domains 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 Create a Extole email domain 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 Update a Extole optout by ID 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 List all Extole reports 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 Create a Extole report 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 Get single Extole report by ID 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 Update a Extole report by ID Update the display name, scopes, tags, or visibility of a pending Extole report run by id. Returns: format, visible, name. Required: id.
• Cancel Extole reports cancel Cancel a pending or in-progress Extole report run by its report ID. Returns: format. Required: report_id.
• Delete Extole reports bulk 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 List all Extole reports tags 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 List all Extole latest download format s 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 List all Extole report download format s 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 List all Extole tokens manageds List all managed API access tokens for the Extole client. Returns: id, name, scopes, duration_seconds.
• Delete Delete a Extole tokens managed by ID Delete a managed API access token in Extole by id. Returns an empty 200 response on success. Required: id.
• List List all Extole event streams 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 Get single Extole event stream by ID Get a single Extole event-stream subscription by id. Returns: id, name. Required: id.
• Delete Delete a Extole event stream by ID 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 List all Extole event streams builts 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 List all Extole event stream filters List all filter rules configured on a specified Extole event stream. Returns: id, type. Required: event_stream_id.
• Create Create a Extole event stream filter 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 Update a Extole event stream filter by ID 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 Delete a Extole event stream filter by ID Archive an Extole event stream filter by id. Returns the archived filter including id and type. Required: event_stream_id, id.
• Get Get single Extole event stream filter by ID 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 List all Extole jobs List all file validation monitor jobs configured for the client in Extole. Returns: id, name, enabled, tasks, triggers.
• Get Get single Extole job by ID Get a file validation monitor job in Extole by id, including its triggers and tasks. Returns: id, name. Required: id.
• Update Update a Extole job by ID 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 Delete a Extole job by ID 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 List all Extole jobs histories 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 Get single Extole jobs history by ID 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 Delete a Extole job task by ID 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 Get single Extole job task by ID 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 List all Extole job triggers List all triggers for a specific Extole job. Returns: id. Required: job_id.
• Create Create a Extole job trigger 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 List all Extole notifications 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 Get single Extole notification by ID 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 List all Extole notifications reads 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 Update a Extole notifications read by ID 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 List all Extole notifications snoozes 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 Create a Extole notifications snooze 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 Get single Extole notifications snooze by ID Get a notification snooze rule by id in Extole for the calling portal user. Returns: id. Required: id.
• List List all Extole notification reads 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 List all Extole report types recommendations 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 Get single Extole reward supplier by ID Get a single reward supplier configuration from Extole by id. Returns: id, description, name, partner_reward_supplier_id, type. Required: id.
• Delete Delete a Extole reward supplier by ID 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 List all Extole reward supplier builts 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 List all Extole subscriptions 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 Update a Extole user subscription by ID 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 Delete a Extole user subscription by ID 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 Get single Extole user subscription by ID 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 Update a Extole webhook by ID 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 List all Extole webhook builts 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 Update a Extole report runner by ID 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 Delete a Extole report runner by ID 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.
• Duplicate Extole report runners 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 List all Extole report runners templates 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 Delete a Extole audience delete by ID 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 Create a Extole client domain validate 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 Create a Extole rename 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 Create a Extole campaign discard 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 Create a Extole campaign launch burst 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 Create a Extole campaign launch test 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 Create a Extole campaign make latest draft 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 Create a Extole campaign make latest published 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 Create a Extole campaign schedule 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 Create a Extole salesforce coupon coupon 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 Create a Extole key unarchive 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 Create a Extole report retry 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 Create a Extole report shared token 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 Create a Extole event stream unarchive 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.
• Update Extole updates bulk 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 Get single Extole reward by ID 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.
• Cancel Extole rewards 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 List all Extole reward cancels 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 List all Extole reward fails 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 List all Extole reward fulfillments 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 List all Extole reward redeems 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 List all Extole reward revokes 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 List all Extole tokens 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.
• Get Extole tokens get consumer 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 Create a Extole person 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.
• Get Extole people get v 4 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 List all Extole person blocks 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.
• Update Extole person blocks bulk 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 Create a Extole datum 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 List all Extole person identity histories 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 List all Extole person locations 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 Create a Extole person membership 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 List all Extole person rewards 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 List all Extole person shareables List all Extole person shareables for a person, sorted by created date descending. Returns: id, content, created_at. Required: person_id.
• Create Create a Extole person shareable 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 List all Extole person steps 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 List all Extole zones 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.
• Action Extole zones render 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.
• Action Extole zones render v 6 named 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 Update a Extole batch by ID 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.
• Cancel Extole batches 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 List all Extole files 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 Create a Extole file 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 Update a Extole file by ID 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 Delete a Extole file by ID 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 Get single Extole sftp destination by ID Get a single SFTP destination connection profile in Extole by id. Returns: id, name, type. Required: id.
• Update Update a Extole sftp destination by ID 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 Delete a Extole sftp destination by ID 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 Create a Extole person forward 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 Create a Extole async event 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 Create a Extole event Submit a consumer event synchronously to Extole. Returns: person_id. Required: event_name. For high-volume ingestion use the async events endpoint instead.
• Create Extole events create named 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 Create a Extole sftp destination sync 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 Create a Extole sftp destination validate 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 Get single Extole share status by ID Get the processing status of a prior share event submission in Extole by polling id. Deprecated. Returns: status. Required: id.
• List List all Extole assets 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 Delete a Extole asset by ID 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 List all Extole asset downloads 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 Get single Extole asset download by ID 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.
• Get Extole asset downloads get web 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.
• List Extole asset downloads list person 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 List all Extole audience memberships List audience memberships for the authenticated consumer in Extole, including eligibility audiences that affect program participation. Returns: audience_id, audience_name, created_at.
• List List all Extole friends 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 List all Extole journeys 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 Create a Extole parameter 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.
• Update Extole parameters bulk 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 Get single Extole send verification email status by ID Get the processing status of a prior verification email send in Extole by polling id. Deprecated. Returns: status. Required: id.
• Get Get single Extole person profile picture URL by ID 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 Get single Extole shareable status by ID 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 Create a Extole send verification email Send a profile verification email in Extole to confirm the authenticated consumer's email address. Returns: polling_id, status. Deprecated.
• Create Create a Extole custom share 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 Create a Extole share batch 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 Get single Extole shareables get create or update by ID 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 Get single Extole shareables get or create by ID 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 List all Extole client domain patterns 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 Delete a Extole client domain pattern by ID 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 List all Extole client domain patterns builts 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 Create a Extole component facet 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 Get single Extole component facet by ID 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 Delete a Extole component facet by ID 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 List all Extole component grants 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 Create a Extole component grant 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 Delete a Extole component grant by ID 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 List all Extole component subscriptions 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 List all Extole component subscriptions builts 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 List all Extole component subscriptions subscribers 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 Create a Extole component type 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 Get single Extole component type by ID 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 Update a Extole component type by ID 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 Get single Extole extended core by ID 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 Delete a Extole extended core by ID 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 List all Extole extended cores builts 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 List all Extole campaign controllers List all controllers for an Extole campaign, optionally filtered by type. Returns: id, name, type.
• Create Create a Extole campaign controller 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.
• Action Extole campaign controllers approves 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.
• Cancel Extole campaign controllers cancel rewards 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.
• Create Extole campaign controllers create memberships 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.
• Action Extole campaign controllers declines 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.
• Action Extole campaign controllers earn rewards 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.
• Action Extole campaign controllers emails 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.
• Action Extole campaign controllers incentivizes 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.
• Delete Extole campaign controllers remove memberships 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.
• Action Extole campaign controllers step signals 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.
• Action Extole campaign controllers data intelligences v 2 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 List all Extole controllers builts 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 Get single Extole controller action by ID Get a campaign controller action. Required: id, controller_id.
• List List all Extole actions approves 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 List all Extole actions cancel rewards 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 Delete a Extole actions cancel reward by ID 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 List all Extole actions create memberships 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 Update a Extole actions create membership by ID 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 Delete a Extole actions create membership by ID 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 Create a Extole actions creative 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 Update a Extole actions creative by ID 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.
• Download Extole actions creatives 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 Update a Extole actions data intelligence by ID 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 Update a Extole actions decline by ID 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.

No tools match your search.