Extole
API integration

create_a_extole_upload_image

Upload an image to a pet in Extole. Returns: type. Required: pet_id.

create_a_extole_pet

Create a new pet in the Extole store. Returns the created pet object including id, name, and status.

extole_pets_bulk_update

Update an existing pet in the Extole store. Returns the updated pet object including id, name, and status. Required: id.

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.

extole_pets_find_by_tags

Find pets in the Extole store by tags. Multiple tags can be provided as comma-separated strings. Returns an array of pets with id, name, status, and tags. Required: tags.

get_single_extole_pet_by_id

Get a single pet from the Extole store by id. Returns the pet object including id, name, and status. Required: id.

update_a_extole_pet_by_id

Update a pet in the extole store with form data. Returns: id, name, status. Required: id.

delete_a_extole_pet_by_id

Delete a pet in extole by id. Returns an empty 204 response on success. Required: id.

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_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.

get_single_extole_store_order_by_id

Get a single store order by id in Extole. Returns the order including its id. Valid IDs are integers between 1 and 10. Required: id.

delete_a_extole_store_order_by_id

Delete a store order by id in Extole. Returns an empty 204 response on success. Required: id.

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_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.

update_a_extole_user_by_id

Update an Extole staff user account by id. Only fields present in the request body are changed. Returns: id. Required: id.

delete_a_extole_user_by_id

Delete an Extole staff user account by id. Returns an empty 204 response on success. Required: id.

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.

get_single_extole_user_by_id

Get a single Extole staff user account by id. Returns: id. Required: id.

extole_users_list_subscriptions

List all notification subscriptions for an Extole user, including channel and filter configuration. Returns: id. Required: user_id.

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.

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_all_extole_user_logins

Log a user into the Extole system. Returns a session token string. Required: username, password.

list_all_extole_user_logouts

Log out the current logged-in user session in Extole. Returns an empty response on success.

create_a_extole_user_create_with_array

Create a list of users in Extole from a given input array of user objects. Returns an empty response on success.

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.

create_a_extole_audience

Create a new audience definition in Extole. Returns the created audience with id, name, enabled, tags, component_references, component_ids, created_at. Required: name. New audiences default to enabled; tags must be 255 chars or fewer each.

get_single_extole_audience_by_id

Get a single Extole audience definition by id, including its name, enabled state, tags, and the campaign components that reference it. Returns: id, name, created_at. Required: id.

update_a_extole_audience_by_id

Update an existing Extole audience by id. Only fields supplied in the body are changed; omitted fields are left untouched. Returns the updated audience with id, name, enabled, tags, component_references, component_ids, created_at. Required: id. Sending null for name returns 400.

delete_a_extole_audience_by_id

Soft-archive an Extole audience by id. Returns the archived audience with id, name, enabled, tags, component_references, component_ids, archived, created_at. Required: id. Fails if the audience is still referenced by a campaign-controller membership trigger, a create-/remove-membership controller action, or a campaign component variable. Reversible via the unarchive endpoint.

extole_audiences_list_members

List the person IDs of all current members of an Extole audience. Returns: person_id for each member. Required: audience_id.

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_all_extole_audience_builts

Get the rendered (built) audience snapshot in Extole for a specific audience — the runtime view the targeting engine evaluates against during targeting. Returns: id, name. Required: audience_id.

list_all_extole_members_download_format_s

Download the full member list for an Extole audience in the specified format. Returns a file stream whose structure depends on the chosen format (.csv, .json, or .xlsx). Required: audience_id, format.

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.

extole_view_details_list_operation

Get an Extole audience operation with its full detail view, including data source configuration and processing statistics. Returns: type, state, data_source, statistics, tags. Required: audience_id, operation_id.

list_all_extole_audience_operations

List audience operations for a specific Extole audience, optionally filtered by state, tags, or operation type. Returns: id, type. Required: audience_id.

create_a_extole_audience_operation

Create a new audience operation in Extole that modifies audience membership by adding, removing, or syncing members from a data source. Returns: id, type, data_source, tags, name. Required: audience_id, type, data_source.

extole_audience_operations_cancel

Cancel a pending or in-progress Extole audience operation. Returns: state. Required: audience_id, operation_id.

get_single_extole_audience_operation_by_id

Get a single Extole audience operation by id. Returns: id, type, data_source, tags, report_id, name, executor_type, format, status, user_id, created_date. Required: audience_id, id.

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_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.

list_all_extole_audience_stats

Get audience membership statistics for an Extole audience. Returns the audience stats object including id and membership statistics attributes such as total member count and size change since the last operation. Required: audience_id.

list_all_extole_client_domains

List Extole client domains, optionally filtered by validation status. Returns each 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. The status filter accepts FAIL or PASS.

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_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.

update_a_extole_client_domain_by_id

Update an Extole client domain by id. Returns the updated 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. Domain and share_uri are not modifiable after creation.

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_all_extole_client_domain_decrypts

Get an Extole client domain with its SSL private key returned in decrypted form. Returns: id, name. Required: client_domain_id.

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_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.

extole_components_duplicate

Duplicate an Extole component by id, creating a deep copy with all child settings and assets. Returns: id, name, type, description, tags, display_name, state, owner, version_state, unique_id, http_status_code, code, message. Required: id, version.

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.

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_all_extole_components_builts

List all built Extole components in their fully evaluated runtime form with expression fields resolved. Returns: id, name, state, owner, type, tags. Max 1000 results per page.

list_all_extole_component_available_upgrades

Get available component upgrades in Extole. Returns a map of available upgrade targets keyed by target component id, where each value contains the upgrade target details. Required: component_id.

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_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_all_extole_duplicatable_builts

List built duplicatable components in Extole, each returned in its fully evaluated runtime form with expression fields resolved. Returns built component objects with id and component-type-specific attributes. Max 1000 items per fetch.

list_all_extole_component_assets

List all file assets attached to an Extole component. Returns: id, name, description. Required: component_id.

create_a_extole_component_asset

Upload a new file asset to an Extole component by supplying asset metadata and file content. Returns: id, description, tags, filename. Required: component_id, asset, file.

update_a_extole_component_asset_by_id

Update an Extole component asset's metadata and optionally replace its file content. Returns: id, description, tags, filename. Required: component_id, id, asset.

delete_a_extole_component_asset_by_id

Delete a component asset from an Extole component. Returns the deleted asset metadata including id, name, description, tags, filename, and content_length. Required: component_id, id.

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_all_extole_assets_builts

List built (compiled) component asset representations for all assets on a specified Extole component. Returns: id, type. Required: component_id.

list_all_extole_asset_builts

Get the built (compiled) representation of a specific Extole component asset. Returns: id. Required: component_id, asset_id.

list_all_extole_contents

Stream the raw file content of an Extole component asset identified by asset_id on the specified component. Returns the asset's file content directly as a stream whose content type varies by asset. Required: component_id, asset_id.

list_all_extole_component_settings

List all configuration settings for a specific Extole component. Returns: name, description, source, type. Required: component_id.

create_a_extole_component_setting

Create a new named configuration setting for an Extole component. Returns the created setting including name, description, display_name, priority, source, tags, type, and values. Required: component_id, name.

update_a_extole_component_setting_by_id

Update a single component setting by id in Extole. Only fields present in the request body are changed. Returns the updated setting including name, description, display_name, priority, source, tags, type, and values. Required: component_id, id.

delete_a_extole_component_setting_by_id

Delete a component setting from an Extole campaign component. Returns the deleted setting record including its name, type, display_name, description, priority, source, tags, and values. Required: component_id, id.

get_single_extole_component_setting_by_id

Get a specific Extole component setting by setting name. Returns: description, type, source. Required: component_id, setting_name.

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_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_all_extole_setting_builts

Get a built component setting in Extole, returning the fully evaluated runtime form with expression fields resolved to concrete values. Returns: type. Required: component_id, setting_name.

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_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/ or may be empty to target the default version.

list_all_extole_blocks

List all content blocks for the Extole client. Returns each block's id, filter_type, list_type, and value. Max fetch size 1000.

create_a_extole_block

Create a new content block in Extole used as a reusable fragment in campaign experiences. Returns the created block including its server-assigned id, filter_type, list_type, and value. Required: filter_type, list_type, value.

get_single_extole_block_by_id

Get a single content block in Extole by id. Returns: id. Required: id.

delete_a_extole_block_by_id

Delete a content block in Extole by id. Returns the deleted block including its id, filter_type, list_type, and value. Required: id.

list_all_extole_blocks_globals

List all globally available content blocks in Extole that can be shared across clients. Returns: id, name. Max fetch size 1000.

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_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_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_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.

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.

extole_campaigns_duplicate

Duplicate an Extole campaign by deep-copying the specified campaign version into a new DRAFT campaign. The copy inherits all components, settings, and labels; the optional body overrides name, description, message, and program_label. Returns: id, description, program_label. Required: id.

extole_campaigns_lock

Lock a campaign version in Extole to prevent concurrent edits. While locked, other callers receive 400 campaign_locked on edit attempts; the lock is associated with the caller's access token and released via the unlock endpoint. Returns the campaign object including id, name, state, created_at, updated_at. Required: id, version, lock_types.

extole_campaigns_pause

Pause an Extole campaign version, transitioning it to paused state to temporarily halt participant eligibility and reward processing. Returns the updated campaign including id, name, and state. Required: id, version. An optional request body with a date can defer the pause to a future time; the campaign can be resumed by publishing it again.

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.

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.

extole_campaigns_unlock

Release the edit lock on a specified Extole campaign version, allowing other callers to edit the campaign again. Returns the campaign object including id, name, and state. Required: id, version, lock_types. Returns 400 campaign_not_locked if the campaign is not currently locked by the caller.

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.

extole_campaigns_download

Download an Extole campaign bundle as a ZIP archive containing all campaign assets, component definitions, and configuration files. Returns a binary ZIP file usable for campaign backup or import into another client via POST /v2/campaigns or PUT /v2/campaigns/{id}. Required: id, version.

extole_campaigns_bulk_update

Update an Extole campaign by replacing its content with a campaign ZIP archive. The version segment acts as an optimistic-lock guard to prevent lost-update races. Returns: id, name, state, version, created_at, updated_at. Required: id, file.

extole_campaigns_bulk_delete

Soft-delete an Extole campaign by id. Deleted campaigns are excluded from standard listings but are recoverable via the undelete endpoint. Requires the campaign to be in a state that permits deletion (e.g. DRAFT or ARCHIVED). Returns: id, name, state, version, created_at, updated_at. Required: id.

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_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_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.

list_all_extole_campaign_versions

List Extole campaign versions ordered from most recent to oldest. Returns: created_at, updated_at. Required: campaign_id. Max 1000 results per page.

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_all_extole_campaign_builts

Get a built Extole campaign by campaign_id, returning the fully evaluated runtime form with all component and setting values resolved. Omit the version segment to retrieve the latest version. Required: campaign_id, version.

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_all_extole_logos

Get the current Extole client logo image metadata. Returns: id, fileName, size.

create_a_extole_logo

Upload a new client logo image to Extole via multipart form upload. Returns: id, fileName, size. Required: attributes (containing fileName and size) and inputStream.

extole_logos_bulk_delete

Archive the current Extole client logo, removing it from active use. Returns: id.

list_all_extole_logo_images

Download the Extole client logo as a PNG image binary. Returns the raw PNG image binary data.

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.

create_a_extole_promotion_link

Create a new promotion link for a participant in Extole. Returns the created link with its server-assigned id, code, label, key, and program_url. Required: code.

get_single_extole_promotion_link_by_id

Get a single Extole promotion link by id. Returns: id, code, content, data, description, key, label, program_url. Required: id.

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_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.

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_all_extole_manual_coupon_coupons_extension_s

Download the manual coupon pool for an Extole reward supplier as a binary file. Returns a binary file stream in CSV or TXT format containing the coupon data. Required: reward_supplier_id, extension (must match the pattern .csv or .txt).

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_all_extole_manual_coupon_stats

Get usage statistics for the coupon pool on a manual coupon supplier in Extole. Returns the coupon pool stats object with usage statistics defined by the CouponStatsResponse schema. Required: reward_supplier_id.

list_all_extole_salesforce_coupons_list_available_coupon_pools

List available Salesforce coupon pools in Extole that can be linked to a reward supplier. Returns an array of coupon pool objects, each with an id.

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_all_extole_salesforce_coupon_stats

Get Salesforce coupon pool usage statistics for a reward supplier in Extole. Returns usage statistics for the coupon pool on this Salesforce coupon supplier. Required: reward_supplier_id.

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_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.

create_a_extole_security_key

Create a new Extole client security key from a JSON body. Supported variants include OAuth, PGP/SSH, JWT, webhook secrets, and password or HTTP basic credentials. Returns: id, name, type, algorithm, description, key, partner_key_id, tags, component_ids, component_references, archived. Required: name, type, algorithm.

update_a_extole_security_key_by_id

Update an existing Extole client security key by id. Only fields present in the request body are changed. Returns: id, type, algorithm, description, key, partner_key_id, tags, component_ids, component_references, archived, name. Required: id.

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.

list_all_extole_keys_builts

List built client keys in Extole with evaluatable fields resolved for the current client context. Returns: id, name, type, description. Supports an optional tags filter where a key is returned only when it includes every supplied tag.

list_all_extole_timeline_entries

List all campaign timeline entries for the client in Extole, optionally filtered by tags. Returns: name, description.

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_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.

extole_timeline_entries_bulk_update

Update an Extole campaign timeline entry by name. Only fields present in the request body are changed. Returns the updated entry including name, date, description, and tags. Required: name.

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_all_extole_user_properties

List all per-user property overrides for a staff user in Extole. Returns: name. Required: user_id.

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.

get_single_extole_user_property_by_id

Get a per-user property override in Extole for a given staff user and property. Returns: name, value, report_id, executor_type, format, status, user_id, created_date. Required: user_id, id.

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.

extole_user_properties_bulk_delete

Delete a per-user property override for a staff user in Extole. Returns: success. Required: user_id, name.

list_all_extole_shareables

List Extole shareables matching a code. Returns shareable objects including id, code, key, label, target_url, share_url, content, and data. Deprecated legacy lookup endpoint.

create_a_extole_shareable

Create a new Extole shareable for the authenticated consumer with a custom code, content, and data. Returns the created shareable including id, code, key, label, target_url, content, and data. Deprecated — use the v6 endpoint instead.

update_a_extole_shareable_by_id

Update an Extole shareable by id for the authenticated consumer. Returns the updated shareable including id, key, label, target_url, content, and data. Required: id. Deprecated legacy endpoint.

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.

extole_shareables_list_legacy

List all shareables owned by the authenticated consumer in Extole (legacy v4). Returns: id, code, content, data, key, label, share_url, target_url, report_id, name, executor_type, format, status, user_id, created_date. Deprecated; use the v6 list endpoint instead.

extole_shareables_create_legacy

Create a new shareable for the authenticated consumer in Extole (legacy v4). Returns the created shareable including id, code, share_url, content, label, and target_url. Deprecated; use the v6 create endpoint instead.

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.

extole_shareables_search_by_code

Search for Extole shareables by code (legacy v4). Returns an array of matching shareables with id, code, label, share_url, content, and target_url. Deprecated.

extole_shareables_create_by_code

Create a shareable for the authenticated consumer in Extole (legacy v4 endpoint, deprecated in favor of POST /api/v6/me/shareables). Returns: id, code, key, label, target_url, content, data, report_id, name, executor_type, format, status, user_id, created_date.

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.

extole_shareables_get_me

Get a shareable by code for the authenticated consumer in Extole. 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 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 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.

get_single_extole_email_domain_by_id

Get a single custom sending domain in Extole by id. Returns: id. Required: id.

update_a_extole_email_domain_by_id

Update a custom sending domain in Extole by id. Only fields present in the request body are changed. Returns: id, domain, force_send_from_email_domain, dkim_cname_records. Required: id.

delete_a_extole_email_domain_by_id

Delete a custom sending domain in Extole by id. Returns the deleted domain including id, domain, force_send_from_email_domain, and dkim_cname_records. Required: id.

list_all_extole_email_domain_validates

Validate an Extole custom sending email domain by checking its DNS records to confirm verification status. Returns the current validation result without making changes. Required: email_domain_id.

list_all_extole_optouts

Get the opt-out suppression state for a person in Extole by email address. An opted-out person will not receive campaign sends or reward awards. Returns: source, type. Required: email.

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.

get_single_extole_optout_by_id

Get the opt-out suppression state for a specific person in Extole by secure email. Returns: email, optout, list_name, list_type, source, type, report_id, name, executor_type, format, status, user_id, created_date. Required: secure_email.

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_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_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_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.

delete_a_extole_report_by_id

Delete an Extole report run by id, including its output data. Returns: name, format. Required: id.

extole_reports_cancel

Cancel a pending or in-progress Extole report run by its report ID. Returns: format. Required: report_id.

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_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_all_extole_reports_latests

Get the most recent completed Extole report run, optionally filtered by tags and ordered by date, name, status, or user. 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.

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).

extole_latest_download_format_s_list_report_runner

Download the latest completed report output produced by a specific Extole report runner. Returns the report file content in the requested format (CSV, JSON, JSONL, XLSX, PSV, or headless variants). Required: report_runner_id.

list_all_extole_reports_recommendations

List report recommendations in Extole for scheduling based on the selected recommendation type. Returns an array of recommended report objects including report_id, name, format, status, executor_type, and created_date. The type query parameter accepts SCHEDULE.

list_all_extole_report_debugs

Get internal debug information for an Extole report run by report ID. Returns: report_id, name, executor_type, format, status, user_id, visible, source, created_date, started_date, completed_Date, error_code, dounload_url. Required: report_id. Restricted to client superusers.

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_all_extole_report_info

Get metadata about a completed Extole report across all available formats, including row count and available column sets. Returns: report_id, name, executor_type, format, status, user_id, visible, source, created_date, started_date, completed_Date, error_code, dounload_url. Required: report_id.

extole_report_info_get_format

Get format-specific metadata about a completed Extole report, such as row count and column names. Returns: content_length, total_rows. Required: report_id, format.

list_all_extole_views_publics

Get the publicly accessible view of an Extole report. Returns the report object including report_id, name, format, status, executor_type, parameters, created_date, started_date, completed_Date, and download URL. Required: report_id.

list_all_extole_tokens_manageds

List all managed API access tokens for the Extole client. Returns: id, name, scopes, duration_seconds.

create_a_extole_tokens_managed

Create a new managed API access token in Extole with configurable scopes, name, and expiry. Returns: id, name, scopes, duration_seconds.

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_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.

create_a_extole_event_stream

Create a new event-stream subscription in Extole. Returns the created event stream including its server-assigned id, name, description, component_ids, component_references, stop_at, and tags. Required: name.

get_single_extole_event_stream_by_id

Get a single Extole event-stream subscription by id. Returns: id, name. Required: id.

update_a_extole_event_stream_by_id

Update an Extole event-stream subscription by id. Only fields present in the request body are changed. Returns: id, description, component_ids, component_references, stop_at, tags, name. Required: id.

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_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_all_extole_event_stream_builts

Get the built (evaluated runtime) configuration for a specific Extole event stream subscription, reflecting component inheritance and dynamic overrides applied at runtime. Returns: id. Required: event_stream_id.

list_all_extole_event_stream_events

List events captured by an Extole event stream, sorted newest first. Returns: name, data. Required: event_stream_id.

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_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_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_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_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_all_extole_jobs

List all file validation monitor jobs configured for the client in Extole. Returns: id, name, enabled, tasks, triggers.

create_a_extole_job

Create a file validation monitor job in Extole. Optional triggers and tasks may be supplied in the same request. Returns: id, name, enabled, tasks, triggers. Required: name.

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_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_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_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_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.

list_all_extole_job_tasks

List all tasks for an Extole job, sorted by execution order. Returns: id. Required: job_id.

create_a_extole_job_task

Add a task to an Extole job. Order defaults to max+1 when omitted. Returns the created task including id, task_type, order, expected_headers, match_mode, and on_mismatch. Required: job_id, task_type.

update_a_extole_job_task_by_id

Update an Extole job task. The request task_type must match the stored task. Returns the updated task including id, task_type, order, expected_headers, match_mode, and on_mismatch. Required: job_id, id, task_type.

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_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_all_extole_job_triggers

List all triggers for a specific Extole job. Returns: id. Required: job_id.

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.

update_a_extole_job_trigger_by_id

Update an Extole job trigger by id. The request trigger_type must match the stored trigger's type. Returns: id, trigger_type, match_type, pattern. Required: job_id, id, trigger_type.

delete_a_extole_job_trigger_by_id

Soft-delete an Extole job trigger by id. Returns: id. Required: job_id, id.

get_single_extole_job_trigger_by_id

Get a specific Extole job trigger by its id. Returns: id, trigger_type, match_type, pattern, path, report_id, name, executor_type, format, status, user_id, created_date. Required: job_id, id.

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_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_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_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_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_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_single_extole_notifications_snooze_by_id

Get a notification snooze rule by id in Extole for the calling portal user. Returns: id. Required: id.

delete_a_extole_notifications_snooze_by_id

Delete a notification snooze rule by id in Extole for the calling portal user. Returns the deleted snooze object including id, comment, expires_at, and having_exactly_tags. Required: id.

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.

update_a_extole_notification_read_by_id

Advance the Extole notification read cursor for a user, marking all notifications created at or before the supplied timestamp as read. Returns: last_read_event_time. Required: user_id, last_read_event_time.

list_all_extole_notification_snoozes

List all active notification snooze rules for an Extole portal user, sorted newest first. Each snooze suppresses notifications matching specified tags until its expiry time. Returns: id. Required: user_id.

create_a_extole_notification_snooze

Create a notification snooze rule that suppresses portal notifications matching specified tags for an Extole user until the expiry timestamp. Returns the created snooze with its assigned id, comment, expires_at, and having_exactly_tags. Required: user_id, having_exactly_tags, expires_at.

delete_a_extole_notification_snooze_by_id

Delete a notification snooze rule for an Extole portal user by id. Returns the deleted snooze object including its id, comment, expires_at, and having_exactly_tags. Notifications previously suppressed by this rule resume immediately. Required: user_id, id.

get_single_extole_notification_snooze_by_id

Get a specific notification snooze rule for an Extole portal user by id. Returns: id, comment, expires_at, having_exactly_tags, report_id, name, executor_type, format, status, user_id, created_date. Required: user_id, id.

list_all_extole_report_types

List Extole report types with optional filtering by display_name, visibility, tags, and search_query. Returns: id, description, type. Max 1000 results per page.

get_single_extole_report_type_by_id

Get a single Extole report type by id. Returns the full definition including id, display_name, description, type, visibility, formats, scopes, parameters, tags, component_references, categories, data_start, allowed_scopes, component_ids, and parent_report_type_id. Required: id.

update_a_extole_report_type_by_id

Update an Extole report type by id with a partial update — only supplied fields are changed. Returns the updated report type with id, display_name, description, type, visibility, formats, scopes, parameters, tags, and component_references. Required: id.

delete_a_extole_report_type_by_id

Delete an Extole report type by id. Returns the deleted report type record including id, display_name, type, visibility, parameters, formats, scopes, tags, and component_references. Fails with report_type_has_dependent_types if other report types depend on it. Required: id.

create_a_extole_report_type

Create a new Extole report type definition (SQL- or CONFIGURED-shaped). Returns the persisted report type with its server-assigned id, display_name, type, visibility, parameters, formats, scopes, tags, component_references, and parent_report_type_id. Report-type definitions are typically managed by Extole staff.

list_all_extole_report_types_clients

List Extole report types alongside the ids of clients that have access to each one. Returns: id, description, type. Max 1000 per page.

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.

list_all_extole_reward_suppliers

List all reward supplier configurations in Extole. Returns: id, description, name, partner_reward_supplier_id, type. Use the types parameter to filter by supplier type and include_archived to include archived suppliers.

create_a_extole_reward_supplier

Create a new reward supplier configuration in Extole. Returns the persisted supplier with its server-assigned id, name, reward_supplier_type, enabled, face_value, and other configuration fields. Required: name, reward_supplier_type.

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.

update_a_extole_reward_supplier_by_id

Update an existing reward supplier configuration in Extole. Only fields present in the request body are changed. Returns the updated supplier including id, name, reward_supplier_type, enabled, face_value. Required: id.

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_all_extole_reward_suppliers_builts

List all built reward suppliers in Extole, returning each in its fully evaluated runtime form. Returns: id, name, reward_supplier_type, face_value, enabled, description, display_name.

list_all_extole_reward_suppliers_display_types

List the available reward supplier display type labels in Extole. Returns an array of unique display type label strings for the client. No required parameters.

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_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_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_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_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.

list_all_extole_webhooks

List all Extole webhooks for the client, optionally filtered by enabled status or type. Returns: id, name, type, url, in, schema.

create_a_extole_webhook

Create a new Extole webhook definition that fires on matching platform events. Returns the persisted webhook with its server-assigned id, name, type, enabled, url, description, tags, request configuration, and retry_intervals. Required: name, type, url. The webhook fires immediately once created unless enabled is set to false.

get_single_extole_webhook_by_id

Get a single Extole webhook definition by id, including its URL, headers, event filters, and state. Returns: id, name, type, url, description. Required: id.

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.

delete_a_extole_webhook_by_id

Archive (soft-delete) an Extole webhook by id. The webhook stops firing immediately but its definition is retained. Returns the archived webhook with id, name, type, enabled, url, description, tags, request, and retry_intervals. Required: id. Fails if the webhook is still referenced by a controller action or user subscription channel.

list_all_extole_webhooks_builts

List all Extole webhooks in their fully evaluated (built) runtime form with all evaluatable fields resolved, including effective endpoint URLs and headers. Returns: id, name, type, description, url. Exposes finer filtering than the standard webhook list endpoint.

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.

list_all_extole_report_runners

List Extole report runners for the calling client, filtered and ordered by query parameters. Report runners are scheduled report execution definitions that run a report type on a recurring schedule and deliver output to a configured destination. Returns: id, name, type. Max 1000 per page.

create_a_extole_report_runner

Create a new Extole report runner definition and schedule it for execution. The runner begins executing on its first scheduled interval after creation. Returns the persisted report runner with its server-assigned id, name, type, report_type, formats, and enabled. Required: name, type.

get_single_extole_report_runner_by_id

Get a single Extole report runner by id. Returns the full report runner definition including id, name, type, report_type, formats, parameters, and delivery configuration. Required: id.

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_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.

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_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_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_a_extole_operation_retry

Retry a failed Extole audience operation identified by its operation ID. Returns the audience operation object including its id, type, state, tags, and data_source. Required: audience_id, operation_id. Retry is only supported for eligible operation states and types.

create_a_extole_audience_unarchive

Restore a previously archived Extole audience so it reappears in default audience and built-audience listings. Returns the unarchived audience object including id, name, enabled, tags, and component_references. Required: audience_id. Fails with 400 audience_not_found if the audience does not exist or has been hard-deleted.

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_a_extole_component_upgrade

Upgrade an Extole component to the latest version of its component type definition. Returns the upgraded component object (ComponentResponse) including its id, name, type, and version. Required: component_id.

create_a_extole_blocks_test

Test an Extole block configuration against a test payload without persisting changes. Returns: list_type, value. Required: list_type, value.

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_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_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_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_a_extole_campaign_live

Set an Extole campaign version live, bypassing the normal test-mode phase. Validates all components and reward rules before transitioning. Returns the updated campaign including id, name, state, and version. Required: campaign_id, version.

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_a_extole_campaign_make_latest_preserve_state

Promote a campaign version to the latest pointer in Extole while preserving its current lifecycle state (draft, published, etc.) unchanged. Returns the updated campaign object including id, name, state, and version. Required: campaign_id, version.

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_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_a_extole_campaign_unarchive

Unarchive an Extole campaign version, restoring it from archived state back to its previous active state so it reappears in standard listings and becomes eligible for editing or publishing. Returns the campaign object including its id, name, and state. Required: campaign_id, version.

create_a_extole_campaign_undelete

Undelete a soft-deleted campaign version in Extole, restoring it to an active state so it reappears in standard listings and can be edited or published. Returns the recovered campaign object including id, name, state, and program_label. Required: campaign_id, version. The version parameter follows the pattern (/version/.+)? — omit the version segment to target the latest version.

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.

extole_salesforce_coupon_coupons_bulk_delete

Delete all unused Salesforce coupons from a reward supplier's pool in Extole. When operation_id is supplied, only coupons from that specific operation are removed. Returns: operation_id. Required: reward_supplier_id.

delete_a_extole_key_delete_by_id

Permanently delete an archived client key in Extole. The key must not be referenced by campaign components or other platform resources. Returns the deleted client key object including its id, name, type, algorithm, and partner_key_id. Required: key_id.

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_a_extole_users_password_reset

Initiate a password reset flow for a staff user in Extole by sending a password-reset email to the user's registered address. Returns: success. Required: email.

create_a_extole_users_resend_invite_email

Resend the invitation email to an Extole staff user who has not yet accepted their invitation. Returns a success response confirming the invitation email was resent. Required: access_token.

create_a_extole_erasure

Submit an irreversible GDPR/privacy erasure request for a person's data in Extole, permanently deleting all personal data associated with the specified person. Returns the erasure record including id, email, partner_user_id, note, and created_at. This action is irreversible.

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_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.

delete_a_extole_event_stream_delete_by_id

Permanently delete an Extole event stream subscription by event_stream_id. Returns the deleted event stream object including its id, name, description, and tags. Required: event_stream_id.

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.

create_a_extole_reward_supplier_unarchive

Unarchive a previously archived reward supplier in Extole, restoring it to active use. Returns the restored supplier including its id, name, enabled, and reward_supplier_type. Required: reward_supplier_id.

extole_components_translatables_bulk_update

Upload translated component variable values to an Extole component from a CSV or Excel file via multipart form upload. Returns an array of batch component variable update response objects. Requires a file upload containing the translated variable data. Optional query parameters: target_component_id to specify the destination component, and ignore_unknown_variables (defaults to true) to silently…

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.

extole_users_update_passwords_bulk_update

Update the password for the authenticated Extole staff user account. Returns the updated user including id, email, first_name, last_name, and scopes. Required: password. The new password must meet Extole's length and strength requirements and cannot be a previously used password.

extole_reward_supplier_deletes_bulk_delete

Permanently delete a reward supplier in Extole. Returns the deleted supplier record including id, name, type, enabled, face_value, and reward_supplier_type. Required: reward_supplier_id.

list_all_extole_rewards

List Extole rewards matching the specified filters. Returns: reward_id, reward_supplier_id, partner_reward_supplier_id, person_id, partner_user_id, email, state, partner_reward_id, created_at. Max 1000 per page.

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.

update_a_extole_reward_by_id

Update attributes on an Extole reward by id. Returns the updated reward including reward_id, state, email, partner_user_id, and created_at. Required: id.

extole_rewards_list_history

List the state-transition history for an Extole reward. Returns: state, created_at, reward_id, partner_reward_id, message, cost_code. Required: reward_id.

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.

extole_rewards_revoke

Revoke an Extole reward by reward_id, marking it as invalid. Returns the updated reward including reward_id, state, email, partner_reward_id, and created_at. Required: reward_id.

list_all_extole_rewards_state_summaries

List aggregate reward state counts from Extole grouped by time period (e.g. EARNED, FULFILLED, CANCELED). Returns: state.

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_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_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_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_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_all_extole_reward_sends

List send events 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_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.

create_a_extole_token

Create a new Extole bearer access token for server-to-Extole calls. The request body is optional; when omitted the new token mirrors the calling identity's scopes. Returns: type, client_id, scopes.

get_single_extole_token_by_id

Get Extole access token metadata by token value. Returns: type, client_id. Required: id.

delete_a_extole_token_by_id

Invalidate an Extole access token immediately by id. Subsequent requests using the same token will fail. Returns an empty 204 response on success. Required: id.

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.

extole_tokens_create_consumer

Create a consumer access token in Extole. Pass an email to identify a consumer when the client identity key is email, a jwt to assert a trusted identity via JWT verification, or omit both for an anonymous token. The optional duration_seconds caps the token lifetime. Returns: scopes.

extole_tokens_delete_consumer

Delete (revoke) a consumer access token in Extole. The token supplied via the access_token parameter or bearer header is immediately invalidated after revocation. Returns: success.

list_all_extole_people

Search for persons in Extole by identity key value or client-defined person keys in name:value format. Returns an array of matching profiles, each including id, identity_key_value, locale, and version. Supply at least one search criterion; the same key may resolve to multiple Extole profiles.

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_single_extole_person_by_id

Get a single Extole person profile by id. Returns: id. Required: id.

update_a_extole_person_by_id

Update the identity key value on an Extole person profile by id. Returns the updated record including id, identity_key_value, locale, and version. Required: id, identity_key_value.

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.

extole_people_get_consumer

Get a public person profile in Extole by person id. Returns: id, first_name, profile_picture_url. Required: person_id. This legacy endpoint is deprecated.

list_all_extole_persons_partner_keys

List partner key names configured for the calling Extole client. Returns an array of unique partner key name strings (e.g., partner_conversion_id, partner_shipment_id) that supplement Extole's built-in person identifiers. Supply include_campaign_ignoring_state to include partner keys declared in a specific campaign regardless of that campaign's state.

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.

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.

list_all_extole_data

List all person data parameters for an Extole person, sorted by updated date in descending order. Returns: name, updated_at. Required: person_id. Results can be filtered by names and scopes.

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.

get_single_extole_datum_by_id

Get a specific person data parameter by name in Extole. Person data parameters are arbitrary key-value pairs attached to a person profile, used in campaign targeting and personalization. Returns: name, value, scope, report_id, executor_type, format, status, user_id, created_date. Required: person_id, id.

extole_data_bulk_update

Update the value of a named person data parameter for an Extole person. Returns: name, scope, value, updated_at. Required: person_id, name. Returns 400 data_not_found if the parameter does not exist or 400 read_only_name if the name is read-only.

extole_data_bulk_delete

Delete a named person data parameter for an Extole person. Returns: name. Required: person_id, name. Returns 400 data_not_found if the parameter does not exist.

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_all_extole_person_journeys

List campaign journeys for a person in Extole, sorted by start date in descending order. Each journey represents a person's participation lifecycle in a specific campaign (e.g. share, refer-a-friend, purchase). Returns: id, name, created_at. Required: person_id.

get_single_extole_person_journey_by_id

Get a specific Extole person journey by id. Returns the campaign journey including its id, name, program, campaign_id, container, data, key, and start_date. Required: person_id, id.

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.

list_all_extole_person_memberships

List audience memberships for a person in Extole, sorted by created date in descending order. Returns: created_at. Required: person_id.

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.

delete_a_extole_person_membership_by_id

Delete a person audience membership in Extole, removing the person from the specified audience. Returns: created_at. Required: person_id, id.

list_all_extole_person_relationships

List referral relationships for a specific Extole person, showing advocate-friend connections created through campaign participation. Returns an array of person relationship records including id and relationship attributes. Required: person_id.

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.

get_single_extole_person_reward_by_id

Get a single reward for a specific Extole person by id, including its state, face value, and associated campaign. 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. Required: person_id, id.

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_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.

update_a_extole_person_shareable_by_id

Update the content of an existing Extole person shareable by id. Returns: id, key, label, program_url, content, data, name. Required: person_id, id.

get_single_extole_person_shareable_by_id

Get a single Extole person shareable by id. Returns: id, key, label, program_url, content, data, report_id, name, executor_type, format, status, user_id, created_date. Required: person_id, id.

list_all_extole_person_shares

List all share events for a person in Extole, sorted by created date in descending order. Each share is recorded when the person distributes a shareable link via a channel (social, email, etc.). Returns: id, created_at. Required: person_id.

get_single_extole_person_share_by_id

Get a specific share event for a person in Extole by id, including its channel, shareable, and associated campaign journey. Returns: id, channel, shareable_id, campaign_id, created_at, report_id, name, executor_type, format, status, user_id, created_date. Required: person_id, id.

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_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.

create_a_extole_zone

Render an Extole zone by name, merging the request body's open data map into the targeting context. Recognised identity fields include email, partner_user_id, person_id, and event_time. Returns the rendered zone content with creative-configuration-specific fields. Required: zone_name.

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.

extole_zones_render_v_6

Render an Extole zone from a backend service by supplying the event name and targeting data in the JSON request body. Returns structured zone content as JSON whose shape varies by the zone's creative configuration. Required: event_name.

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.

extole_zones_render_web

Render an Extole zone from a browser page or web SDK by supplying the event 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. If event_name is omitted, returns an empty 200 with the access token still allocated.

extole_zones_render_web_named

Render a named Extole zone from a browser page or web SDK, specifying the zone name in the URL path and passing 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.

list_all_extole_batches

List Extole batch jobs ordered by creation date descending. Returns each job with id, name, event_name, status, tags, user_id, success_rows, failed_rows, and data_source configuration. Filter by name, event_name, tags, status, or user_id. Default page size is 100.

create_a_extole_batch

Create a new asynchronous batch job in Extole that reads its data source row-by-row and dispatches a consumer event per row. Returns the full job record including id, name, event_name, status, data_source, and tags with an initial status of PENDING. Required: data_source. The job begins processing immediately; poll the get batch job endpoint to monitor status until it reaches a terminal state.

get_single_extole_batch_by_id

Get a single Extole batch job by id. Returns the full job record including id, status, success_rows, failed_rows, name, event_name, and data_source configuration. Required: id. Poll this endpoint to monitor job progress until status reaches a terminal state: DONE, FAILED, CANCELED, or EXPIRED.

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.

delete_a_extole_batch_by_id

Delete an Extole batch job by id. Returns the final job record at the time of deletion including id, name, status, success_rows, and failed_rows. Required: id. The job must be in a terminal state (DONE, FAILED, CANCELED, or EXPIRED); this action is irreversible.

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_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_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.

get_single_extole_file_by_id

Get a single file asset in Extole by id. Returns: id, name, tags, status, review_status, size, format. Required: id.

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_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.

list_all_extole_file_downloads

Download the raw content of an Extole file asset. Returns the file content stream in its original format (CSV, PSV, or JSON). Required: file_id. Maximum 1000 rows per request.

list_all_extole_sftp_destinations

List all SFTP destination connection profiles configured for the client in Extole. Returns: id, name, type. Filterable by type, name, username, and host.

create_a_extole_sftp_destination

Create a new SFTP destination connection profile in Extole for automated report file delivery. Returns the created destination including id, name, type, host, username, port, dropbox_path, key_id, extole_key_id, and partner_key_id.

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_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_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_a_extole_custom_reward_failed

Mark an Extole custom reward as failed, recording a fulfilment failure. Returns the updated reward object including reward_id, state, person_id, email, and created_at. Required: reward_id.

create_a_extole_custom_reward_fulfilled

Mark a custom reward as fulfilled in Extole, signalling that the client system has completed fulfilment. Returns the updated reward object including reward_id, state, email, partner_reward_id, reward_supplier_id, person_id, partner_user_id, partner_reward_supplier_id, and created_at. Required: reward_id, message.

create_a_extole_custom_reward_fulfilled_and_sent

Mark a custom Extole reward as both fulfilled and sent to the participant in a single call. Returns the updated reward object including reward_id, state, email, partner_reward_id, and created_at. Required: reward_id, message.

create_a_extole_custom_reward_redeemed

Mark a custom Extole reward as redeemed by the participant. Returns the updated reward object including reward_id, state, email, person_id, and created_at. Required: reward_id.

create_a_extole_custom_reward_sent

Mark an Extole custom reward as sent to the participant. Returns the updated reward including reward_id, reward_supplier_id, state, partner_reward_id, and created_at. Required: reward_id.

create_a_extole_reward_retry

Retry fulfilment of a previously failed reward in Extole. Returns the updated reward object including reward_id, state, person_id, email, partner_reward_id, and created_at. Required: reward_id. Only rewards in a retryable (e.g. FAILED) state can be retried.

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_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.

extole_async_events_create_named

Submit a named consumer event asynchronously in Extole by event name. Returns: event_id, reward_id, data. The request body is an open data map of event attributes; person identification occurs asynchronously after the response is returned. Required: event_name.

create_a_extole_batche_expire

Expire a completed Extole batch job, releasing its data source reference. Only jobs in terminal state (DONE, FAILED, or CANCELED) can be expired. Returns the updated job record including batch_id, status, success_rows, failed_rows, and data_source. Required: batch_id.

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.

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_a_extole_file_expire

Expire an Extole file asset, releasing its stored content and setting status to EXPIRED. Returns the updated record including id, name, status, review_status, size, format, tags, and created_at. Required: file_id. Expired assets remain queryable but cannot be used as a batch job data source.

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_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.

update_a_extole_tokens_exchange_by_id

Exchange an Extole access token for a fresh one with the same scopes and a renewed expiry. The original token is invalidated immediately on success. Returns: type, client_id, scopes. Required: id.

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.

extole_share_status_get_custom

Get the processing status of a prior custom share event submission in Extole by polling id. Deprecated. Returns: status, report_id, name, executor_type, format, user_id, created_date. Required: statu_id.

list_all_extole_profiles

Get the authenticated consumer's profile in Extole. Returns: email, partner_user_id, first_name, last_name, profile_picture_url.

update_a_extole_profile_by_id

Update the authenticated consumer's profile in Extole, including identity attributes such as email, first name, last name, partner user id, and profile picture URL, as well as consent fields. Returns: email, partner_user_id, first_name, last_name, profile_picture_url.

list_all_extole_advocates

List advocate relationships for the authenticated consumer in Extole. Deprecated — returns advocates who referred the authenticated consumer. Returns: id, attributes.

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.

create_a_extole_asset

Upload a new asset and attach it to the authenticated consumer's profile in Extole. Supply asset metadata in the asset form field and the file content in the file form field. Returns: id. Required: asset, file. Upload is subject to MIME type, size, and per-consumer asset count validation.

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.

get_single_extole_asset_by_id

Get a single asset by ID from the authenticated consumer's profile in Extole. Use the download endpoints to retrieve the asset content. Returns: id, data_type, name, tags, report_id, executor_type, format, status, user_id, created_date. Required: id.

list_all_extole_assets_downloads

Download a named asset for a specific Extole person via the 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. Required: person_id.

get_single_extole_assets_download_by_id

Download a named asset from the authenticated consumer's Extole profile via the server API. Returns the binary asset content stream with the asset's stored content type, or a 302 redirect if the content is hosted remotely.

extole_assets_downloads_get_web

Download a named asset from the authenticated consumer's Extole profile via the 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.

extole_assets_downloads_list_person

Download a named asset for a specific Extole person via the server API. Returns the binary asset content stream with the asset's stored content type, or a 302 redirect if the content is hosted remotely. Required: person_id.

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_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.

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.

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_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.

get_single_extole_email_status_by_id

Get the email send processing status in Extole by polling id. Deprecated — returns the processing status for a prior POST /api/v4/me/email call; poll until the send reaches a terminal state. Returns: status. Required: id.

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_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.

list_all_extole_parameters

List all custom data fields (parameters) stored on the authenticated consumer's profile in Extole. Returns a dynamic map where each top-level key is a brand-defined parameter name and each value is an object.

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.

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.

list_all_extole_referrals_from_mes

List referral relationships from the authenticated consumer in Extole, where the consumer is the advocate who referred others. Returns: id, created_at.

list_all_extole_referrals_to_mes

List referrals to the authenticated consumer in Extole, returning referral relationships where the consumer is the referred friend. Returns an array of referral relationship objects representing the advocate-friend connections created through campaign participation.

list_all_extole_rewards_status

Get the current redemption status of a reward in Extole for the authenticated consumer. Returns: reward_id, reward_supplier_id, partner_reward_supplier_id, person_id, partner_user_id, email, state, partner_reward_id, created_at, data. Supply exactly one of polling_id, reward_name, or partner_event_id; poll this endpoint until the reward reaches a terminal state (CANCELED, FAILED, or REVOKED).

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_single_extole_shareables_status_by_id

Get the processing status of an asynchronous shareable creation in Extole by polling id. Returns: status. Required: id. Deprecated — this is a legacy endpoint.

list_all_extole_shares

List Extole shares with optional partner filters. Deprecated — for the authenticated consumer's shares use the me/shares endpoint instead. Returns: id.

get_single_extole_share_by_id

Get a single Extole share by id. Deprecated — for the authenticated consumer's shares use the me/shares endpoint instead. Returns: id. Required: id.

extole_shares_get_me

Get the authenticated consumer's Extole share by share_id. Returns: id, share_id, partner_share_id, partner_id, report_id, name, executor_type, format, status, user_id, created_date. Required: share_id.

extole_shares_list_me

List shares recorded for the authenticated consumer in Extole. Returns: share_id, partner_share_id, partner_id, channel, shareable_id, campaign_id, report_id, name, executor_type, format, status, user_id, created_date. Filter by partner_share_id or partner_id to narrow the result set.

list_all_extole_steps

List program steps completed by the authenticated Extole consumer. Returns each step's campaign_id, program_label, step_name, quality, and partner event id fields. All filter parameters are optional; use campaign_id, program_label, step_name, or quality to narrow the result set.

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.

list_all_extole_person_profile_picture_urls

Get a person's profile picture URL in Extole. Returns the profile picture URL as a plain text string. Required: person_id.

list_all_extole_person_assets

List all Extole assets attached to a person profile. Assets are binary or text files such as wallet passes, QR codes, or uploaded images. Returns: id, name, created_at. Required: person_id.

get_single_extole_person_asset_by_id

Get a single Extole person asset by id. Returns full asset metadata including id, data_type, name, and tags. Required: person_id, id.

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_a_extole_events_share

Submit a share event in Extole on behalf of the authenticated advocate. Returns: polling_id, which can be used to poll the share event status via the share status endpoint. Deprecated — use POST /api/v6/email/share instead.

create_a_extole_email

Send an email on behalf of the authenticated consumer in Extole. Deprecated — prefer event-based email flows where available. Returns: polling_id for polling the email send status via the email status endpoint. Required: zone_name, data.

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_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_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_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_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_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.

create_a_extole_client_domain_pattern

Create a new client domain pattern in Extole. Returns the created pattern including id, pattern, type, client_domain_id, test, and component_references. Required: pattern.

get_single_extole_client_domain_pattern_by_id

Get a single client domain pattern by id in Extole. Returns: client_domain_id, component_ids, component_references, id, pattern, test, type. Required: id.

update_a_extole_client_domain_pattern_by_id

Partially update a client domain pattern in Extole — only fields present in the body are changed; omitted fields are left intact. Returns: client_domain_id, component_ids, component_references, id, pattern, test, type. Required: id.

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_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.

list_all_extole_client_domain_pattern_builts

Get the fully evaluated (built) runtime form of an Extole client domain pattern, with all BuildtimeEvaluatable fields resolved to their current values. Returns: client_domain_id, component_ids, component_references, id, pattern, test, type. Required: client_domain_pattern_id.

list_all_extole_component_facets

List Extole component facet (category) definitions for the calling client. Facets group component types into logical categories shown in the campaign editor. Returns: allowed_values, created_date, display_name, name, updated_date.

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_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.

update_a_extole_component_facet_by_id

Apply a partial update to an Extole component facet (category) by id. Returns the updated facet including name, display_name, allowed_values, and created_date. Required: id.

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_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_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_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_all_extole_component_grants_granters

List Extole component granters — the clients that have granted component access to other clients. Returns: client_id, client_name, client_short_name, component_path, grant_id, granted_date, preview_domain, subscription_mode, report_id, name, executor_type, format, status, user_id, created_date. The response is an array of ComponentGranterResponse objects; the upstream schema definition is not…

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.

create_a_extole_component_subscription

Subscribe an Extole client to receive updates from a specified shared component. Returns: client_id, component_ids, component_path, component_references, subscribed_date, subscription_id. The full response shape is defined by the upstream ComponentSubscriptionResponse schema.

delete_a_extole_component_subscription_by_id

Remove an Extole client's subscription to a shared component by id. Returns: client_id, component_ids, component_path, component_references, subscribed_date, subscription_id. The full response shape is defined by the upstream ComponentSubscriptionResponse schema. Required: id.

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_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.

list_all_extole_component_types

List Extole component types for the calling client, optionally filtered by parent or archived status. Returns: created_date, display_name, name, parent, schema, updated_date, archived, facets. Component types define the structure (settings, facets) of campaign components.

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_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_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.

delete_a_extole_component_type_by_id

Archive a component type in Extole by id. Archived types are hidden from the dashboard but their existing component instances remain. Returns the archived component type definition including its name, display_name, parent, and schema. Returns 400 component_type_not_found if the name does not match any accessible type. Required: id.

list_all_extole_extended_cores

List all JavaScript SDK core extensions (extended cores) in Extole. Returns: component_ids, component_references, created_date, enabled, id, source_code, updated_date. Set include_archived=true to include archived extensions.

create_a_extole_extended_core

Create a new JavaScript SDK core extension in Extole. Returns the persisted extended core with its server-assigned id, enabled state, source_code, and component_references. The extension is created in an active state. Required: source_code.

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.

update_a_extole_extended_core_by_id

Update a JavaScript SDK core extension by id in Extole. Only fields present in the body are changed; omitted fields are left intact. Returns: component_ids, component_references, created_date, enabled, id, source_code, updated_date. Required: id.

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_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_all_extole_extended_core_builts

Get the built (fully evaluated) runtime form of an Extole extended core by id, with all evaluatable fields resolved to their current values for use by the SDK core loader. Returns: component_ids, component_references, created_date, enabled, id, source_code, updated_date. Required: extended_core_id.

list_all_extole_campaign_controllers

List all controllers for an Extole campaign, optionally filtered by type. Returns: id, name, type.

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.

extole_campaign_controllers_data_intelligences

List all data-intelligence actions configured on an Extole campaign controller. Returns: action_id, action_type, component_ids, component_references, enabled, quality, event_name, intelligence_provider, profile_risk_update_interval, id. Required: controller_id.

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.

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.

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.

extole_campaign_controllers_creatives

Create a creative action on an Extole campaign controller. When the controller's triggers fire, the action renders the configured creative asset for the participant. Returns: action_id, action_type, component_ids, component_references, enabled, quality, api_version, classification, has_creative, latest_version, output, theme_version, id. Required: controller_id.

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.

extole_campaign_controllers_displays

Create a display action on an Extole campaign controller. When the controller's triggers fire, the action controls which content zone or creative is displayed to the participant. Returns: action_id, action_type, component_ids, component_references, enabled, quality, body, headers, response, id. Required: controller_id.

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.

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.

extole_campaign_controllers_expressions

Create an expression action on an Extole campaign controller. When the controller's triggers fire, this action evaluates the configured JavaScript expression in the campaign runtime context. Returns the created expression action including its server-assigned id, enabled, quality, and expression. Required: controller_id.

extole_campaign_controllers_fire_as_person

Create a fire-as-person action on an Extole campaign controller. When the controller's triggers fire, this action fires the configured campaign step as a different person identity. Returns the created fire-as-person action including its server-assigned id, enabled, quality, event_name, as_person_identification, and as_person_journey. Required: controller_id.

extole_campaign_controllers_fulfill_rewards

Create a fulfill-reward action on an Extole campaign controller. When the controller's triggers fire, this action fulfills a previously earned reward, triggering downstream fulfilment logic. Returns the created fulfill-reward action including its server-assigned id, enabled, quality, reward_id, partner_reward_id, and message. Required: controller_id.

extole_campaign_controllers_incentivize_status_updates

Create an incentivize-status-update action on an Extole campaign controller. When the controller's triggers fire, this action updates the status of a pending incentivize action. Returns: action_id, action_type, component_ids, component_references, enabled, quality, data, event_type, legacy_action_id, message, move_to_pending, partner_event_id, review_status, id. Required: controller_id.

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.

extole_campaign_controllers_redeem_rewards

Create a redeem-reward action on an Extole campaign controller. When the controller's triggers fire, this action marks a reward as redeemed by the participant. Returns: action_id, action_type, component_ids, component_references, enabled, quality, data, event_time, partner_event_id, reward_id, id. Required: controller_id.

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.

extole_campaign_controllers_revoke_rewards

Create a revoke-reward action on an Extole campaign controller. When the controller's triggers fire, this action revokes a previously issued reward, marking it as invalidated. Returns: action_id, action_type, component_ids, component_references, enabled, quality, message, reward_id, id. Required: controller_id.

extole_campaign_controllers_schedules

Create a schedule action on an Extole campaign controller to fire a configured action at a future date. Returns: action_id, action_type, component_ids, component_references, enabled, quality, data, dates, delays, extra_data, force, schedule_name, id. Delays and dates are mutually exclusive. Required: controller_id.

extole_campaign_controllers_share_events

Create a share-event action on an Extole campaign controller that records a share event for the participant when triggers fire. Returns: action_id, action_type, component_ids, component_references, enabled, quality, id. Required: controller_id.

extole_campaign_controllers_signals

Create a signal action on an Extole campaign controller that fires a configured signal event into the campaign pipeline. Returns: action_id, action_type, component_ids, component_references, enabled, quality, data, signal_polling_id, id. Required: controller_id.

extole_campaign_controllers_signals_v_1

Create a legacy signal-v1 action on an Extole campaign controller that fires a v1 signal event into the campaign pipeline (deprecated; prefer the signal action). Returns: action_id, action_type, component_ids, component_references, enabled, quality, data, signal_polling_id, id. Required: controller_id.

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.

extole_campaign_controllers_webhooks

Create a webhook action on an Extole campaign controller. When the controller's triggers fire, the action posts the configured payload to an external webhook URL. Returns: action_id, action_type, component_ids, component_references, enabled, quality, data, webhook_id, id. Required: controller_id.

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.

extole_campaign_controllers_data_intelligences_create

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: action_id, action_type, component_ids, component_references, enabled, quality, event_name, intelligence_provider, profile_risk_update_interval, id. Required: controller_id.

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.

list_all_extole_controller_actions

List all campaign controller actions in Extole, across all action types. Returns: id. Required: controller_id.

get_single_extole_controller_action_by_id

Get a campaign controller action. Required: id, controller_id.

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.

update_a_extole_actions_approve_by_id

Update an Extole approve action on a campaign controller — only fields present in the request body are changed. 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: id, controller_id.

delete_a_extole_actions_approve_by_id

Delete an approve action from an Extole campaign controller. Returns the deleted action record including id, enabled, quality, event_type, and component_ids. Required: id, controller_id.

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.

update_a_extole_actions_cancel_reward_by_id

Update a cancel-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_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_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_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_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.

list_all_extole_actions_creatives

Get a creative action configuration in Extole for the specified action id on a campaign controller. Returns: action_id, action_type, component_ids, component_references, enabled, quality, api_version, classification, has_creative, latest_version, output, theme_version, id. Required: controller_id, action_id.

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_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.

delete_a_extole_actions_creative_by_id

Delete a creative action from an Extole campaign controller. Returns the deleted action record including its id, api_version, classification, enabled, quality. Required: id, controller_id.

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.

list_all_extole_actions_data_intelligences

Get a data-intelligence action configuration in Extole by campaign, controller, and action id. Returns: action_id, action_type, component_ids, component_references, enabled, quality, event_name, intelligence_provider, profile_risk_update_interval, id. Required: controller_id, action_id.

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.

delete_a_extole_actions_data_intelligence_by_id

Delete a data-intelligence action from an Extole campaign controller. Returns the deleted action record including id, enabled, event_name, intelligence_provider, quality, profile_risk_update_interval, component_ids, component_references. Required: id, controller_id.

list_all_extole_actions_declines

Get a decline action configuration for a specific campaign controller action in Extole. 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_id.

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.

delete_a_extole_actions_decline_by_id

Delete a decline action from a campaign controller in Extole. Returns the deleted action record including id, cause_type, event_type, quality, enabled. Required: id, controller_id.

list_all_extole_actions_earn_rewards

Get an earn-reward action configuration in Extole for a specific action id on a campaign controller. 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: controller_id, action_id.

update_a_extole_actions_earn_reward_by_id

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.

delete_a_extole_actions_earn_reward_by_id

Delete an earn-reward action from an Extole campaign controller. 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.

list_all_extole_actions_expressions

Get an expression action configuration for a specific action on an Extole campaign controller. Returns: action_id, action_type, component_ids, component_references, enabled, quality, data, expression, id. Required: controller_id, action_id.

update_a_extole_actions_expression_by_id

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 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.

list_all_extole_actions_fulfill_rewards

Get a fulfill-reward action configuration in Extole by action id on a campaign controller. Returns: action_id, action_type, component_ids, component_references, enabled, quality, event_time, message, partner_reward_id, reward_id, success, id, amount. Required: controller_id, action_id.

update_a_extole_actions_fulfill_reward_by_id

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.

delete_a_extole_actions_fulfill_reward_by_id

Delete a fulfill-reward action from an Extole campaign controller. Returns the deleted action record including id, enabled, reward_id, amount, quality, message, partner_reward_id. Required: id, controller_id.

list_all_extole_actions_redeem_rewards

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.

update_a_extole_actions_redeem_reward_by_id

Update a redeem-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, partner_event_id, reward_id, id. Required: id, controller_id.

delete_a_extole_actions_redeem_reward_by_id

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

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_remove_membership_by_id

Update a remove-membership 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, audience_id, id. Required: id, controller_id.

delete_a_extole_actions_remove_membership_by_id

Delete a remove-membership action from an Extole campaign controller. Returns the deleted action record including id, audience_id, component_ids, component_references, enabled, quality. Required: id, controller_id.

list_all_extole_actions_revoke_rewards

Get a revoke-reward action configuration on an Extole campaign controller. Returns: action_id, action_type, component_ids, component_references, enabled, quality, message, reward_id, id. Required: controller_id, action_id.

update_a_extole_actions_revoke_reward_by_id

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 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.

list_all_extole_actions_schedules

Get a schedule action configuration in Extole for a specific action on a campaign controller. Returns: action_id, action_type, component_ids, component_references, enabled, quality, data, dates, delays, extra_data, force, schedule_name, id. Required: controller_id, action_id.

update_a_extole_actions_schedule_by_id

Update a schedule 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, dates, delays, extra_data, force, schedule_name, id. Dates and delays are not supported together. Required: id, controller_id.

delete_a_extole_actions_schedule_by_id

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

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.

update_a_extole_actions_share_event_by_id

Update a share-event 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, id. Required: id, controller_id.

delete_a_extole_actions_share_event_by_id

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.

list_all_extole_actions_signals_v_1_s

Get a signal-v1 action configuration from an Extole campaign controller. Returns: action_id, action_type, component_ids, component_references, enabled, quality, data, signal_polling_id, id. Required: controller_id, action_id.

update_a_extole_actions_signals_v_1_by_id

Update a signal-v1 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.

delete_a_extole_actions_signals_v_1_by_id

Delete a signal-v1 action from an Extole campaign controller. Returns the deleted action record including id, component_ids, component_references, data, enabled, quality, signal_polling_id. Required: id, controller_id.

list_all_extole_actions_signals

Get a signal action configuration on an Extole campaign controller by action id. Returns: action_id, action_type, component_ids, component_references, enabled, quality, data, signal_polling_id, id. Required: controller_id, action_id.

update_a_extole_actions_signal_by_id

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.

delete_a_extole_actions_signal_by_id

Delete a signal action from an Extole campaign controller. Returns the deleted action record including id, component_ids, component_references, data, enabled, name, quality, and signal_polling_id. Required: id, controller_id.

list_all_extole_actions_step_signals

Get a step-signal action configuration for a specific campaign controller in Extole. Returns: action_id, action_type, component_ids, component_references, enabled, quality, polling_id, id. Required: controller_id, action_id.

update_a_extole_actions_step_signal_by_id

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.

delete_a_extole_actions_step_signal_by_id

Delete a step-signal action from an Extole campaign controller. Returns the deleted action record including id, name, enabled, polling_id, quality, component_ids, and component_references. Required: id, controller_id.

list_all_extole_actions_webhooks

Get an Extole webhook action configuration by action id on a campaign controller. Returns: action_id, action_type, component_ids, component_references, enabled, quality, data, webhook_id, id. Required: controller_id, action_id.

update_a_extole_actions_webhook_by_id

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 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.

list_all_extole_actions_displays

Get a display action configuration from an Extole campaign controller. Returns: action_id, action_type, component_ids, component_references, enabled, quality, body, headers, response, id. Required: controller_id, action_id.

update_a_extole_actions_display_by_id

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.

delete_a_extole_actions_display_by_id

Delete a display action from an Extole campaign controller. Returns the deleted action record including its id, body, component_ids, component_references, enabled, headers, quality, and response. Required: id, controller_id.

list_all_extole_display_builts

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

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 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 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

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.

list_all_extole_actions_fire_as_persons

Get a fire-as-person action configuration in Extole by action id. 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: controller_id, action_id.

update_a_extole_actions_fire_as_person_by_id

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 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

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.

list_all_extole_actions_incentivize_status_updates

Get an incentivize-status-update action in Extole by its action id on a campaign controller. Returns: action_id, action_type, component_ids, component_references, enabled, quality, data, event_type, legacy_action_id, message, move_to_pending, partner_event_id, review_status, id. Required: controller_id, action_id.

update_a_extole_actions_incentivize_status_update_by_id

Update an incentivize-status-update 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, data, event_type, legacy_action_id, message, move_to_pending, partner_event_id, review_status, id. Required: id, controller_id.

delete_a_extole_actions_incentivize_status_update_by_id

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_incentivize_status_update_builts

Get the built incentivize-status-update action in Extole, returning its fully evaluated runtime form with all expression fields resolved. Returns: action_id, action_type, component_ids, component_references, enabled, quality, data, event_type, legacy_action_id, message, move_to_pending, partner_event_id, review_status. Required: controller_id, action_id.

list_all_extole_actions_incentivizes

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.

update_a_extole_actions_incentivize_by_id

Update an Extole incentivize action on a campaign controller — only fields present in the request body are changed. Returns the updated action including id, action_name, incentivize_action_type, enabled, quality, review_status, component_ids, component_references, data, and overrides. Required: id, controller_id.

delete_a_extole_actions_incentivize_by_id

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

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_controller_triggers

List all triggers on a controller. Required: controller_id.

get_single_extole_controller_trigger_by_id

Get a campaign controller trigger by id in Extole, returning the trigger configuration regardless of trigger type. Returns: id, report_id, name, executor_type, format, status, user_id, created_date. Omit the version segment to target the latest campaign version. Required: id, controller_id.

list_all_extole_triggers_builts

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

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 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 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.

create_a_extole_triggers_access

Create an Extole access trigger on a campaign controller. The trigger fires when a participant accesses the campaign via a tracked URL. 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, trusted_scopes.

list_all_extole_triggers_audience_membership_events

Get a single Extole audience membership event 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, audience_ids, event_types, id. Required: controller_id, trigger_id.

update_a_extole_triggers_audience_membership_event_by_id

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.

delete_a_extole_triggers_audience_membership_event_by_id

Delete an Extole audience membership event trigger by id, removing it from the specified campaign controller. Returns the deleted trigger record including id, trigger_name, trigger_phase, enabled, event_types, audience_ids, component_ids, negated, parent_trigger_group_name, trigger_description, component_references. Required: id, controller_id.

create_a_extole_triggers_audience_membership_event

Create an Extole audience membership event trigger on a campaign controller. The trigger fires on audience membership lifecycle events such as join and leave. Returns the created trigger with its server-assigned id, trigger_name, trigger_phase, enabled, event_types, audience_ids, component_ids, negated, parent_trigger_group_name, trigger_description, component_references. Required: controller_id.

list_all_extole_triggers_audience_memberships

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.

update_a_extole_triggers_audience_membership_by_id

Update an Extole audience membership 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, having_any_audience_id, person_id, id. Required: id, controller_id.

delete_a_extole_triggers_audience_membership_by_id

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_audience_membership

Create an Extole audience membership trigger on a campaign controller that fires when a participant joins or leaves the configured audience. Returns the created trigger including id, trigger_name, trigger_phase, enabled, having_any_audience_id. Required: controller_id.

list_all_extole_triggers_client_domains

Get a client domain trigger in Extole by its trigger id on a specific campaign controller. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, client_domain_ids, id. Required: controller_id, trigger_id.

update_a_extole_triggers_client_domain_by_id

Update a client domain trigger in Extole on a specific campaign controller. Only fields present in the request body are changed. Returns the updated trigger including id, trigger_name, trigger_description, trigger_phase, enabled, negated, client_domain_ids, component_ids, component_references, parent_trigger_group_name. Required: id, controller_id.

delete_a_extole_triggers_client_domain_by_id

Delete a client domain trigger from an Extole campaign controller. Returns the deleted trigger record including id, trigger_name, trigger_phase, client_domain_ids, and enabled. Required: id, controller_id.

create_a_extole_triggers_client_domain

Create a client domain trigger on an Extole campaign controller that fires when a participant's referral or action originates from the configured client domain. Returns the created trigger including id, trigger_name, trigger_phase, client_domain_ids, and enabled. Required: controller_id.

list_all_extole_triggers_data_intelligence_events

Get a Data Intelligence event trigger in Extole by its trigger id. 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, trigger_id.

update_a_extole_triggers_data_intelligence_event_by_id

Update a Data Intelligence 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_name, id. Required: id, controller_id.

delete_a_extole_triggers_data_intelligence_event_by_id

Delete a Data Intelligence event trigger from an Extole campaign controller. Returns the deleted trigger record including id, event_name, trigger_name, trigger_phase, enabled, negated, trigger_description, parent_trigger_group_name, component_ids, component_references. Required: id, controller_id.

create_a_extole_triggers_data_intelligence_event

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.

list_all_extole_triggers_has_identities

Get a has-identity 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, id. Required: controller_id, trigger_id.

update_a_extole_triggers_has_identity_by_id

Update a has-identity trigger in Extole 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, id. Required: id, controller_id.

delete_a_extole_triggers_has_identity_by_id

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 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.

list_all_extole_triggers_has_prior_rewards

Get a has-prior-reward trigger configuration from 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, count_matches, count_max, count_min, filter_expression, filter_expressions, filter_face_value_types, filter_max_age, filter_max_date, filter_min_age,…. Required: controller_id, trigger_id.

update_a_extole_triggers_has_prior_reward_by_id

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.

delete_a_extole_triggers_has_prior_reward_by_id

Delete a has-prior-reward trigger from an Extole campaign controller. Returns the deleted trigger record including id, trigger_name, trigger_phase, enabled, and filter_scope. Required: id, controller_id.

create_a_extole_triggers_has_prior_reward

Create a has-prior-reward trigger on an Extole campaign controller. Fires when a participant does or does not have a prior reward of the configured type. 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,…. Required: controller_id.

list_all_extole_triggers_has_prior_steps

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.

update_a_extole_triggers_has_prior_step_by_id

Update a has-prior-step trigger in Extole by id. 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_campaign_id, filter_campaign_ids, filter_expression, filter_expressions,…. Required: id, controller_id.

delete_a_extole_triggers_has_prior_step_by_id

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.

create_a_extole_triggers_has_prior_step

Create a has-prior-step trigger in Extole on a campaign controller. The trigger fires when a participant does or does not have a prior completed step. 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,…. Required: controller_id.

list_all_extole_triggers_legacy_labels_targetings

Get a legacy label targeting trigger configuration in Extole. 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, trigger_id.

update_a_extole_triggers_legacy_labels_targeting_by_id

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.

delete_a_extole_triggers_legacy_labels_targeting_by_id

Delete a legacy label targeting trigger in Extole. Returns the deleted trigger record including id, trigger_name, trigger_description, trigger_phase, enabled, negated, parent_trigger_group_name, component_ids, component_references. Required: id, controller_id.

create_a_extole_triggers_legacy_labels_targeting

Create a legacy label targeting trigger in Extole. Deprecated; prefer audience membership trigger. 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.

list_all_extole_triggers_max_minds

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_max_mind_by_id

Update a MaxMind 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, allow_high_risk_email, default_quality_score, ip_threshold, risk_threshold, id. Required: id, controller_id.

delete_a_extole_triggers_max_mind_by_id

Delete a MaxMind trigger from an Extole campaign controller. Returns the deleted trigger record including id, trigger_name, trigger_phase, enabled, risk_threshold, ip_threshold, allow_high_risk_email, default_quality_score, negated, trigger_description, parent_trigger_group_name, component_ids, component_references. Required: id, controller_id.

create_a_extole_triggers_max_mind

Create a MaxMind trigger on an Extole campaign controller. The trigger fires when the MaxMind fraud-score for the participant falls within the configured threshold. 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,…. Required: controller_id.

list_all_extole_triggers_referred_by_events

Get a referred-by-event trigger in Extole. Returns the trigger configuration including id, trigger_name, trigger_phase, referral_originator, enabled, negated, and component references. Required: controller_id, trigger_id.

update_a_extole_triggers_referred_by_event_by_id

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 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 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

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 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.

delete_a_extole_triggers_reward_event_by_id

Delete a reward event trigger from an Extole campaign controller. Returns the deleted trigger record including component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_name, trigger_phase, event_names, reward_states, slots, tags, and id. Required: id, controller_id.

create_a_extole_triggers_reward_event

Create a reward event trigger on an Extole campaign controller that fires on reward lifecycle events. 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: controller_id.

list_all_extole_triggers_scores

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.

update_a_extole_triggers_score_by_id

Update a score 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, cause_event_name, channel, score_result, id. Required: id, controller_id, cause_event_name, score_result.

delete_a_extole_triggers_score_by_id

Delete a score trigger from an Extole campaign controller. Returns the deleted trigger record including id, trigger_name, trigger_phase, score_result, cause_event_name, enabled. Required: id, controller_id.

create_a_extole_triggers_score

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

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 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.

delete_a_extole_triggers_send_reward_event_by_id

Delete a send-reward-event trigger from an Extole campaign controller. Returns the deleted trigger record including id, trigger_name, trigger_phase, reward_names, reward_states, and enabled. Required: id, controller_id.

create_a_extole_triggers_send_reward_event

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

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.

update_a_extole_triggers_share_by_id

Update a share 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, channels, quality, share_types, id. Required: id, controller_id, channels, quality.

delete_a_extole_triggers_share_by_id

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 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

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 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.

delete_a_extole_triggers_zone_state_by_id

Delete a zone state trigger from an Extole campaign controller. Returns the deleted trigger record including its id, trigger_name, trigger_phase, zone_name, and enabled. Required: id, controller_id.

create_a_extole_triggers_zone_state

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.

list_all_extole_triggers_event_targetings

Get an Extole event targeting trigger configuration for a specified 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, targeting_attributes, id. Required: controller_id, trigger_id.

update_a_extole_triggers_event_targeting_by_id

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.

delete_a_extole_triggers_event_targeting_by_id

Delete an event targeting trigger from an Extole campaign controller. Returns the deleted trigger record including id, trigger_name, trigger_phase, targeting_attributes, enabled, and component_ids. Required: id, controller_id.

create_a_extole_triggers_event_targeting

Create an event targeting trigger on an Extole campaign controller. The trigger fires when an inbound event matches the configured targeting criteria. 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: controller_id, targeting_attributes.

list_all_extole_event_targeting_builts

Get the fully evaluated (built) runtime form of an event targeting 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, targeting_attributes. The version parameter may be…. Required: controller_id, trigger_id.

list_all_extole_triggers_events

Get an event trigger configuration on an Extole campaign controller by its trigger id. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, event_names, event_type, id. Required: controller_id, trigger_id.

update_a_extole_triggers_event_by_id

Update an 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, event_type, id. Required: id, controller_id.

delete_a_extole_triggers_event_by_id

Delete an event trigger from an Extole campaign controller. Returns the deleted trigger record including id, trigger_name, event_type, event_names, enabled, trigger_phase, negated, component_ids, component_references, trigger_description, parent_trigger_group_name. Required: id, controller_id.

create_a_extole_triggers_event

Create an event trigger on an Extole campaign controller. When an event matching the configured event name fires for a participant, the controller's actions are executed. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, event_names, event_type, id. Required: controller_id, event_names, event_type.

list_all_extole_event_builts

Get a built event trigger. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name. Required: controller_id, trigger_id.

list_all_extole_triggers_expressions

Get an expression trigger configuration from 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, data, expression, id. Required: controller_id, trigger_id.

update_a_extole_triggers_expression_by_id

Update an expression 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, data, expression, id. Required: id, controller_id, data, expression.

delete_a_extole_triggers_expression_by_id

Delete an expression trigger from an Extole campaign controller. Returns the deleted trigger record including id, trigger_name, trigger_phase, expression, enabled, and data. Required: id, controller_id.

create_a_extole_triggers_expression

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_expression_builts

Get the fully evaluated (built) runtime form of an expression trigger in Extole, with all expression fields resolved at build time. Returns the built expression trigger object. Required: controller_id, trigger_id.

list_all_extole_triggers_groups

Get a group trigger. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name. Required: controller_id, trigger_id.

update_a_extole_triggers_group_by_id

Update a group trigger on an Extole campaign controller. Only fields present in the request body are changed. Returns the updated trigger including its id, trigger_name, trigger_phase, enabled, operator, and component references. Required: id, controller_id.

delete_a_extole_triggers_group_by_id

Delete a group trigger from an Extole campaign controller. Returns the deleted trigger record including id, trigger_name, trigger_phase, enabled, operator, and negated. Required: id, controller_id.

create_a_extole_triggers_group

Create a group trigger on an Extole campaign controller. The group trigger fires when all or any of its contained child triggers fire, based on the operator logic. Returns the created trigger including id, trigger_name, trigger_phase, enabled, operator, and negated. Required: controller_id.

list_all_extole_group_builts

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.

list_all_extole_triggers_journey_checks

Get a journey check trigger configuration from 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, journey_name, person_id, id. Required: controller_id, trigger_id.

update_a_extole_triggers_journey_check_by_id

Update a journey check 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, journey_name, person_id, id. Required: id, controller_id.

delete_a_extole_triggers_journey_check_by_id

Delete a journey check trigger from an Extole campaign controller. Returns the deleted trigger record including id, trigger_name, journey_name, enabled, and trigger_phase. Required: id, controller_id.

create_a_extole_triggers_journey_check

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_journey_check_builts

Get a built journey check trigger in Extole, returning the fully evaluated runtime form 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, journey_name, person_id, id. Required: controller_id, trigger_id.

list_all_extole_triggers_legacy_qualities

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.

update_a_extole_triggers_legacy_quality_by_id

Update a legacy quality 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, action_type, id. Required: id, controller_id, action_type.

delete_a_extole_triggers_legacy_quality_by_id

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.

create_a_extole_triggers_legacy_quality

Create a legacy quality trigger on an Extole campaign controller (deprecated). Returns the created trigger with its server-assigned id, action_type, trigger_name, trigger_phase, enabled, negated, component_ids, component_references, parent_trigger_group_name, and trigger_description. Required: controller_id, action_type.

list_all_extole_legacy_quality_builts

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

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.

update_a_extole_triggers_step_event_by_id

Update a step 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, having_any_data_name, id. Required: id, controller_id.

delete_a_extole_triggers_step_event_by_id

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 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_step_event_builts

Get the built (fully evaluated) runtime form of a step event 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, event_names, having_any_data_name, id. Required: controller_id, trigger_id.

list_all_extole_triggers_sticky_journeys

Get a sticky journey trigger configuration in Extole by its trigger id. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, label, id. Required: controller_id, trigger_id.

update_a_extole_triggers_sticky_journey_by_id

Update a sticky journey 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, label, id. Required: id, controller_id.

delete_a_extole_triggers_sticky_journey_by_id

Delete a sticky journey trigger from an Extole campaign controller. Returns the deleted trigger record including id, trigger_name, trigger_description, trigger_phase, enabled, label, negated, component_ids, component_references, parent_trigger_group_name. Required: id, controller_id.

create_a_extole_triggers_sticky_journey

Create a sticky journey trigger on an Extole campaign controller. The trigger fires based on the participant's sticky journey state in the campaign. Returns: component_ids, component_references, enabled, negated, parent_trigger_group_name, trigger_description, trigger_id, trigger_name, trigger_phase, trigger_type, label, id. Required: controller_id.

list_all_extole_sticky_journey_builts

Get the built (fully evaluated) runtime form of a sticky journey 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, label, id. Required: controller_id, trigger_id.

list_all_extole_triggers_targetings

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 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.

delete_a_extole_triggers_targeting_by_id

Delete a targeting trigger from an Extole campaign controller. Returns the deleted trigger record including id, trigger_name, trigger_description, enabled, negated, scope, trigger_phase, component_ids, component_references, parent_trigger_group_name. Required: id, controller_id.

create_a_extole_triggers_targeting

Create a targeting trigger on an Extole campaign controller that fires when a participant matches the configured targeting rule expression. 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.

list_all_extole_builts

Get a built targeting trigger in Extole, returning the fully evaluated runtime form of the trigger with all expression fields resolved. Required: controller_id, trigger_id.

list_all_extole_trigger_builts

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/ and may be empty. Required: controller_id, trigger_id.

list_all_extole_campaign_flow_steps

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.

create_a_extole_campaign_flow_step

Create a new flow step in an Extole campaign. Flow steps are the visual builder blocks of a participant's journey. Returns the created flow step including id, name, flow_path, step_name, sequence, icon_type, metrics, apps, tags, and words. Required: apps, flow_path, icon_color, icon_type, metrics, name, sequence, step_name, tags.

update_a_extole_campaign_flow_step_by_id

Update an Extole campaign flow step by id. Only fields present in the request body are changed. Returns the updated flow step including id, name, flow_path, step_name, sequence, icon_type, metrics, apps, tags, and words. Required: id.

delete_a_extole_campaign_flow_step_by_id

Delete an Extole campaign flow step by id. Returns the deleted flow step record including id, name, flow_path, step_name, sequence, icon_type, and metrics. Required: id.

get_single_extole_campaign_flow_step_by_id

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 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

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/ or may be empty for the default campaign version. Required: flow_step_id.

list_all_extole_flow_step_apps

List all Extole campaign flow step apps for a given flow step. Returns: component_ids, component_references, description, id, type. Required: flow_step_id.

create_a_extole_flow_step_app

Create a new Extole campaign flow step app. Returns the created app including its server-assigned id, name, description, type, component_ids, and component_references. Required: flow_step_id, name, type.

get_single_extole_flow_step_app_by_id

Get a single Extole campaign flow step app by id. Returns: component_ids, component_references, description, id, type. Required: id, flow_step_id.

update_a_extole_flow_step_app_by_id

Update an existing Extole campaign flow step app by id. Only fields present in the request body are changed. Returns: component_ids, component_references, description, id, type. Required: id, flow_step_id.

delete_a_extole_flow_step_app_by_id

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_apps_builts

List built campaign flow step apps. Returns: component_ids, component_references, description, name, type. Required: flow_step_id.

list_all_extole_app_builts

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.

list_all_extole_flow_step_metrics

List all tracking metrics for a specific campaign flow step in Extole. Returns each metric with id, name, expression, unit, tags, description, component_ids, and component_references. Required: flow_step_id.

create_a_extole_flow_step_metric

Create a new tracking metric on a campaign flow step in Extole. Returns the created metric including id, name, expression, unit, tags, and component_references. Required: flow_step_id, description, expression, name, tags, unit.

get_single_extole_flow_step_metric_by_id

Get a single campaign flow step metric by id in Extole. Returns the metric object including id, name, expression, unit, tags, description, component_ids, and component_references. Required: id, flow_step_id.

update_a_extole_flow_step_metric_by_id

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 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.

list_all_extole_metrics_builts

List built campaign flow step metrics. Returns: component_ids, component_references, description, expression, id, name, tags, unit. Required: flow_step_id.

list_all_extole_metric_builts

Get the fully evaluated (built) runtime form of an Extole campaign flow step metric, with expression fields resolved. Returns: component_ids, component_references, description, expression, id, tags, unit. Required: flow_step_id, flow_step_metric_id.

list_all_extole_clients

List all Extole clients accessible to the currently authenticated staff user. Returns: client_id, name, id.

get_single_extole_step_status_by_id

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_debug_modes

Set or clear the Extole debug container cookie that pins the consumer API to a specific deployment container. Returns an opaque success response with no documented body fields. Pass enable=false to disable the cookie. Expert-only debugging endpoint. Required: container.

list_all_extole_public_steps

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 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

Get the resource-scoped access token associated with the current Extole credentials. Returns: access_token, expires_in, identity_id, resources.

extole_tokens_resources_bulk_delete

Revoke a resource-scoped access token in Extole. Returns an empty 204 response on success. Required: access_token_to_delete.

list_all_extole_dimensions

List Extole dimension combinations, optionally filtered by campaign, program label, container, or step name. Returns arrays of dimension name strings, where each array represents one dimension combination.

get_single_extole_dimension_by_id

Get a single Extole dimension's values and statistics by id, optionally filtered by campaign, program label, container, and time period. Returns: count, value. Required: id.

list_all_extole_prehandlers

List all Extole prehandlers sorted by execution order. Returns: actions, component_ids, component_references, conditions, created_date, description, enabled, id, name, order, tags, updated_date. Filter by tags and optionally include archived prehandlers.

create_a_extole_prehandler

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.

get_single_extole_prehandler_by_id

Get a single Extole prehandler by id, including its script, conditions, and lifecycle state. Returns: actions, component_ids, component_references, conditions, created_date, description, enabled, id, name, order, tags, updated_date. Required: id.

update_a_extole_prehandler_by_id

Partially update an Extole prehandler by id — only fields present in the body are changed; omitted fields are left intact. Returns: actions, component_ids, component_references, conditions, created_date, description, enabled, id, name, order, tags, updated_date. Required: id.

delete_a_extole_prehandler_by_id

Permanently delete an Extole prehandler by id. Deletion is irreversible. Returns: actions, component_ids, component_references, conditions, created_date, description, enabled, id, name, order, tags, updated_date. Required: id.

extole_prehandlers_archive

Archive (soft-delete) an Extole prehandler, removing it from the event-processing pipeline while retaining its definition. Returns: actions, component_ids, component_references, conditions, created_date, description, enabled, id, name, order, tags, updated_date. Required: prehandler_id.

list_all_extole_prehandlers_builts

List all built prehandlers in Extole in their fully evaluated runtime form, sorted by execution order. Built prehandlers have all evaluatable fields resolved, reflecting the current live pipeline state rather than source definitions. Returns: actions, component_ids, component_references, conditions, created_date, description, enabled, id, name, order, tags, updated_date.

list_all_extole_prehandler_builts

Get the fully evaluated (built) runtime form of an Extole prehandler by prehandler id, with all evaluatable fields resolved for the event-processing pipeline. Returns: actions, component_ids, component_references, conditions, created_date, description, enabled, id, name, order, tags, updated_date. Required: prehandler_id.

list_all_extole_report_runners_tags

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_views_detaileds

List Extole report runner views with optional filtering by type, report type, display name, user IDs, tags, pause status, and aggregation status. Returns: name. Max 1000 results per page.

get_single_extole_views_detailed_by_id

Get a report runner view for a specified report runner in Extole. Returns: report_id, name, 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_accumulating_reports

List accumulating reports for an Extole report runner, optionally filtered by status. 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_latests

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 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 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

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.

extole_report_type_clients_bulk_delete

Revoke Extole client access from a PRIVATE report type by removing supplied client_ids. Returns the updated report type including id, display_name, description, parameters, formats, scopes, visibility, and tags. Required: id.

delete_a_extole_client_domain_pattern_delete_by_id

Hard-delete an Extole client domain pattern by id. Unlike archiving, deletion is irreversible. Returns the deleted pattern record including its id, pattern, type, client_domain_id, test, and component_references. Required: id.

create_a_extole_client_domain_pattern_unarchive

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

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_extended_core_unarchive

Restore a previously archived Extole JavaScript SDK core extension, re-inserting it into the SDK core loader. Returns the restored extended core including its id, component_ids, component_references, enabled, and source_code. Returns 404 extended_core_not_found if the id does not exist. Required: extended_core_id.

create_a_extole_consumer_authorize

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 a consumer access token for a specific person in Extole. Returns: access_token, client_id, scopes. Required: person_id.

create_a_extole_verify_jwt

Verify a JWT signature against the key material stored on a JWT client key in Extole. Deprecated — the JWT kid header must match the key's partner_key_id. Returns the JWT verification response object including its attributes. Required: key_id, jwt.

create_a_extole_debug_client_event

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_content_security_policy_report

Submit a browser Content-Security-Policy violation report to Extole for logging and investigation. Returns an opaque success response on submission. Required: csp-report.

create_a_extole_debug_log

Send a log message to Extole. Returns the created log object including its level and message. Required: level, message.

create_a_extole_email_domain_generate_dkim_record

Generate new DKIM DNS records for an Extole custom sending domain by email domain id. Returns the DKIM CNAME records (each with alias and canonical_name) that must be added to DNS to enable DKIM signing. Required: email_domain_id.

create_a_extole_email_validate

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_oauth_token

Create an OAuth client credentials token in Extole by exchanging client_id and client_secret for an API access token using the client credentials grant flow. Returns the access token and expiry information as described by the OAuthAccessTokenResponse schema.

create_a_extole_openid_connect_authorization_code_flow

Create a managed access token in Extole by exchanging an OpenID Connect authorization code. Returns: access_token, access_token_id, access_token_response, client_id, create_date, created_at, expire_date, expires_in, name, id, in, schema. Required: code, duration_seconds, name, scopes, state.

extole_openid_connect_authorization_code_flows_create_unmanaged

Exchange an OpenID Connect authorization code for an unmanaged Extole access token. Expert-level; most integrators should use POST /v4/tokens instead. Returns: access_token, client_id, expires_in, identity_id, person_id, scopes, type. Required: code, state.

create_openid_connect_idp_initiated_authorization_code_flow

Exchange an IdP-initiated OIDC authorization code for an Extole access token. Returns: access_token, client_id, expires_in, identity_id, person_id, scopes, type. Expert-only; most integrators use POST /v4/tokens instead. Required: auth_provider_type_id, code.

create_a_extole_address_validate

Validate a postal address in Extole by submitting address lines and a region code. Returns the normalized address including address_lines and region_code. Required: address_lines, region_code.

create_a_extole_prehandler_unarchive

Unarchive a previously archived Extole prehandler, restoring it and re-inserting it into the execution pipeline. Returns the restored prehandler including its id, name, enabled, order, conditions, actions, and component references. Required: prehandler_id.

create_a_extole_generate_missing_report

Generate missing report slots for a scheduled Extole report runner, up to an optional limit. Returns an array of report objects including report_id, name, executor_type, format, status, created_date, started_date, completed_Date, and dounload_url. Required: report_runner_id.

create_a_extole_report_runner_run

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

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_parameters_adds_bulk_update

Append dynamic parameters to an Extole report type's parameters list. Returns the updated report type including id, display_name, description, type, visibility, formats, scopes, allowed_scopes, parameters, tags, categories, component_ids, component_references, data_start, and parent_report_type_id. Only dynamic parameters can be added; use createReportType or updateReportType for…. Required: id.

extole_report_type_parameters_deletes_bulk_update

Remove dynamic parameters from an Extole report type by supplying their names. Returns the updated report type including id, display_name, description, parameters, formats, scopes, visibility, tags, and component_references. Static parameters cannot be deleted via this endpoint — use updateReportType to change those. Required: id.

extole_report_type_tags_adds_bulk_update

Add tags to an Extole report type by id. Existing tags are left unchanged; duplicates in the body are ignored. Returns the updated report type including id, display_name, description, tags, and parameters. Required: id.

extole_report_type_tags_deletes_bulk_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.