Skip to main content
Faraday logo
  • Category: artificial intelligence
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 117
  • Triggers: 0
  • Slug: FARADAY
  • Version: 20261101_00

Tools

Slug: FARADAY_ARCHIVE_COHORTArchive a Faraday cohort, optionally cascading the archive to downstream resources. Archiving stops updates while keeping the cohort visible.

Input Parameters

string
required
The UUID of the cohort to archive. Archiving stops updates but keeps the cohort visible. Example: ‘ac030f6a-a728-4fcd-b34a-d5b7ba09d60c’
array
Only allow the following resource UUIDs to be archived. If a downstream resource would be archived and is not in this list, an error will be thrown. Cannot be used together with cascade_to_all.
boolean
When true, archive the cohort and all its downstream resources. When false, throw an error if there are downstream resources that would be archived. Cannot be used together with cascade_to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_ARCHIVE_CONNECTIONArchive a Faraday connection, optionally cascading the archive to downstream resources. Archiving stops updates while keeping the connection visible.

Input Parameters

array
Only allow the following resource UUIDs to be archived. If a downstream resource would be archived and is not in this list, an error will be thrown. Cannot be used together with cascade_to_all.
string
required
The UUID of the connection to archive. Archiving stops updates but keeps the connection visible. Example: ‘eca0b539-5002-49f0-ac5e-ff4acd1d85b1’
boolean
When true, archive the connection and all its downstream resources. When false, throw an error if there are downstream resources that would be archived. Cannot be used together with cascade_to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_ARCHIVE_DATASETTool to archive a dataset in Faraday. Use when you need to archive a dataset and optionally its downstream resources. Archiving stops updates to the resource but keeps it visible.

Input Parameters

array
Only allow the following resources to be archived. If a downstream resource would be archived and is not in this list, throw an error. List of UUIDs.
string
required
The UUID of the dataset to archive.
boolean
When archiving a resource, if this is set to true, archive the resource and all its downstream resources. If false, and there are downstream resources that would be archived, throw an error.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_ARCHIVE_OUTCOMEArchive a Faraday outcome, optionally cascading the archive to downstream resources. Archiving stops updates while keeping the outcome visible.

Input Parameters

array
Only allow the following resource UUIDs to be archived. If a downstream resource would be archived and is not in this list, an error will be thrown. Cannot be used together with cascade_to_all.
string
required
The UUID of the outcome to archive. Archiving stops updates but keeps the outcome visible. Example: ‘d0e90b8d-f69d-420d-b191-8438421cdc8e’
boolean
When true, archive the outcome and all its downstream resources. When false, throw an error if there are downstream resources that would be archived. Cannot be used together with cascade_to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_ARCHIVE_PERSONA_SETArchive a Faraday persona set, optionally cascading the archive to downstream resources. Archiving stops updates while keeping the persona set visible.

Input Parameters

array
Only allow the following resource UUIDs to be archived. If a downstream resource would be archived and is not in this list, an error will be thrown. Cannot be used together with cascade_to_all.
boolean
When true, archive the persona set and all its downstream resources. When false, throw an error if there are downstream resources that would be archived. Cannot be used together with cascade_to.
string
required
The UUID of the persona set to archive. Archiving stops updates but keeps the persona set visible. Example: ‘8505e525-128c-4ede-a279-85f372aa6aaf’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_ARCHIVE_PLACEArchive a Faraday place, optionally cascading the archive to downstream resources. Archiving stops updates while keeping the place visible.

Input Parameters

string
required
The UUID of the place to archive. Archiving stops updates but keeps the place visible. Example: ‘a1eafa5c-020a-427f-ae18-2d0b3c0fced7’
array
Only allow the following resource UUIDs to be archived. If a downstream resource would be archived and is not in this list, an error will be thrown. Cannot be used together with cascade_to_all.
boolean
When true, archive the place and all its downstream resources. When false, throw an error if there are downstream resources that would be archived. Cannot be used together with cascade_to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_ARCHIVE_SCOPEArchive a Faraday scope, optionally cascading the archive to downstream resources. Archiving stops updates while keeping the scope visible.

Input Parameters

string
required
The UUID of the scope to archive. Archiving stops updates but keeps the scope visible. Example: ‘fce4d114-9516-4e8c-a92e-e1ed13d5369d’
array
Only allow the following resource UUIDs to be archived. If a downstream resource would be archived and is not in this list, an error will be thrown. Cannot be used together with cascade_to_all.
boolean
When true, archive the scope and all its downstream resources. When false, throw an error if there are downstream resources that would be archived. Cannot be used together with cascade_to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_ARCHIVE_STREAMTool to archive a stream in Faraday. Use when you need to archive a stream and optionally its downstream resources. Archiving stops updates to the resource but keeps it visible.

Input Parameters

array
Only allow the following resource UUIDs to be archived. If a downstream resource would be archived and is not in this list, an error will be thrown. Cannot be used together with cascade_to_all.
boolean
When true, archive the stream and all its downstream resources. When false, throw an error if there are downstream resources that would be archived. Cannot be used together with cascade_to.
string
required
The stream’s UUID or name to archive. Example: ‘b8907e67-dac8-4fc2-a332-7676f0077dd8’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_ARCHIVE_TARGETTool to archive a target in Faraday. Use when you need to archive a target and optionally its downstream resources. Archiving stops updates to the resource but keeps it visible.

Input Parameters

string
required
The UUID of the target to archive. Example: ‘eb3450c4-f1d3-4edd-8d70-d1b4f7c16348’
array
Only allow the following resource UUIDs to be archived. If a downstream resource would be archived and is not in this list, an error will be thrown. Cannot be used together with cascade_to_all.
boolean
When true, archive the target and all its downstream resources. When false, throw an error if there are downstream resources that would be archived. Cannot be used together with cascade_to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_ARCHIVE_TRAITArchive a Faraday trait to stop its updates while keeping it visible. The request can also cascade archival to specified downstream resources or all downstream resources.

Input Parameters

string
required
The UUID of the trait to archive. Archiving stops updates but keeps the trait visible. Example: ‘1b3411ea-0082-4873-bd3d-1f5c6586012e’
array
Only allow the following resource UUIDs to be archived. If a downstream resource would be archived and is not in this list, an error will be thrown. Cannot be used together with cascade_to_all.
boolean
When true, archive the trait and all its downstream resources. When false, throw an error if there are downstream resources that would be archived. Cannot be used together with cascade_to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_CREATE_ACCOUNTSTool to create a new Faraday account with specified name and branding. Use when you need to provision a new account in Faraday.

Input Parameters

string
required
The name of the account. Must be non-empty and max 64 characters.
object
Whitelabel branding configuration for the account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_CREATE_COHORTSTool to create a new cohort in Faraday. Cohorts are groups of people that share certain traits or behaviors. Use when you need to define a new cohort from your datasets or from Faraday’s US Consumer Graph. At least one of stream_name, traits, or place_conditions must be provided.

Input Parameters

string
required
Human-readable label for this cohort. Must be non-empty and max 64 characters.
array
List of traits to filter cohort membership. At least one of stream_name, traits, or place_conditions must be provided.
boolean
Whether to show the Cohort in Explore, the map view on https://app.faraday.ai. This will slow down Cohort builds.
object
Recency condition for event-based filtering.
number
Maximum count for this cohort’s config
number
Maximum value for this cohort’s config
number
Minimum count for this cohort’s config
number
Minimum value for this cohort’s config
string
The name field of the stream from which to build this cohort. At least one of stream_name, traits, or place_conditions must be provided.
array
List of places to use to spatially filter Cohort membership. At least one of stream_name, traits, or place_conditions must be provided.
array
List of stream properties to filter cohort membership on. The stream properties must be for the same stream set as the cohort stream_name. Nulls are excluded unless explicitly requested with _null: true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_CREATE_DATASETCreate a Faraday dataset with identity mappings and limited source options, including hosted CSV upload directory and delimiter. The action supports preview and selected ingestion settings.

Input Parameters

string
required
Identifying name for the dataset
object
required
Dataset connection options specifying how to connect to and read the data. Must include type field.
boolean
If true, dataset will only detect columns and produce preview without ingesting data.
string
Connection identifier in UUID format. Required if using a connection-based dataset type.
object
required
Mapping of identity set names to objects describing personally identifiable information. Each key is a logical grouping name (e.g., ‘customers’, ‘leads’) and the value describes how to extract PII from dataset rows.
array
Primary key columns that uniquely identify rows to prevent duplication.
array
Identity matching providers to use, in order of priority.
string
Name of a date column for efficient incremental data loading.
array
Column names that reference IDs from external systems.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_CREATE_OUTCOMETool to create a new outcome. Outcomes are predictions about customer behavior such as likelihood to convert, churn, or purchase specific products. Use when you need to create a new predictive model.

Input Parameters

string
required
Human-readable label for this outcome. Each outcome must have a unique name. Must be non-empty.
boolean
An outcome in preview mode will not build until preview is turned off.
object
Configuration for features used during modeling.
object
Bias mitigation configuration for age and gender dimensions.
string ("auto" | "static")
Prediction mode for outcome modeling.
array
Field or category names that should not be considered for this outcome, primarily for Responsible AI purposes.
string
A cohort of people who could attain or attrite the desired outcome. If not specified, uses the US population.
string
A cohort of counterexamples - people who have clearly failed to attain the outcome.
string
required
A cohort of people who have attained the desired outcome (e.g., existing customers if predicting prospect to customer transition).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_CREATE_PERSONA_SETTool to create a new persona set. Persona sets segment cohorts into distinct customer personas based on shared characteristics and behaviors. Use when you need to generate customer personas for a cohort.

Input Parameters

string
required
Human-readable label for this persona set. Must be non-empty and max 64 characters.
boolean
Display persona set in Explore map view at https://app.faraday.ai. This will slow down persona set builds.
boolean
A persona set in preview mode will not build until preview is turned off.
string
required
The cohort for which to build personas.
array
Customer attributes for modeling (e.g., fig/age, fig/gender). These fields define the characteristics used to segment the cohort into personas.
integer
Specific persona count. If omitted, the number of personas is automatically determined.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_CREATE_PLACECreate a place from addresses or GeoJSON for use as a spatial filter. Places are deprecated in favor of atlases, though existing places remain readable and writable.

Input Parameters

string
required
Human-readable label for this place. Names must be unique. Uniqueness is case-insensitive. Must be non-empty and max 64 characters.
object
A GeoJSON Geometry, as defined in the GeoJSON specification. The longitude and latitude units are in decimal degrees, using the WGS84 coordinate reference system (SRID 4326). Either addresses or geojson must be provided.
array
List of addresses to be geocoded. Either addresses or geojson must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_CREATE_SCOPESTool to create a new scope in Faraday. Scopes define the population and payload for predictions, specifying which cohorts to target and what outcomes to include. Use when you need to define output data instructions for a new scope.

Input Parameters

string
required
Human-readable label for this scope. Each scope must have a unique name.
object
required
Specifies data to include for each person in the scope.
boolean
required
When true, provides limited output records without billing charges. A preview scope provides only a limited number of output records, but it is not billed.
object
required
Defines which people to include in the scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_CREATE_STREAMSTool to create a new stream or find an existing stream by name. Use when you need to initialize a stream for event data collection.

Input Parameters

string
required
The name of the event stream to find or create. Maximum length is 64 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_CREATE_TARGET_PREVIEWTool to start a preview delivery for a target. Use when you need to initiate a preview of target data before full deployment.

Input Parameters

string
required
The UUID of a target

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_CREATE_TARGETSTool to create a target in Faraday. Use when you need to set up a deployment that exports predictions and cohort data to external destinations like CRMs, ad platforms, or data warehouses.

Input Parameters

string
required
A user-friendly name for the target (max 64 characters)
object
Row restriction configuration by count or percentile.
object
Row-level filtering criteria for the target.
object
required
The export target configuration options varying by connection type
string
required
The UUID of a scope for configuration
string
For replication targets; omit for hosted targets
boolean
When true, use literal names instead of machine-readable IDs in the output
object
required
Specifies the output formatting mode (hashed, referenced, identified, or aggregated)
object
Configuration for geographic and trait analysis.
array
Column mapping transformations for custom output structure

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_CREATE_TRAITTool to create a new trait in Faraday. Use when you need to define a new fact about a person or geographic entity that can be used in modeling, analysis, and reporting.

Input Parameters

string
required
How to refer to this Trait in other API calls to Faraday. Must start with a lowercase letter or underscore, followed by lowercase letters, numbers, or underscores.
string
For numeric types, in what units is the data stored.
string
A more human-consumable version of the name of this field.
string
Information about this field.
object
A mapping of the input values used in modeling, to how they should be displayed in reports.
string ("categorical" | "multicategorical" | "ordinal" | "nominal")
The nature of data represented by the trait.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_CREATE_WEBHOOK_ENDPOINTSTool to create a new webhook endpoint. Use when you need to register a webhook URL to receive notifications when resources are ready or encounter errors.

Input Parameters

string
required
The destination URL for webhook notifications. Must be a valid HTTPS URL.
array
required
Event types that trigger the webhook. Must contain at least one event type. Available events: ‘resource.errored’ (when a resource encounters an error) and ‘resource.ready_with_update’ (when a resource is ready with updates).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_DELETE_ACCOUNTTool to delete an account by its UUID. Use when you need to permanently remove an account from Faraday. The deletion is scheduled asynchronously and returns a 202 status on success.

Input Parameters

string
required
The UUID of the account to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_DELETE_ALL_ORPHANED_TRAITSTool to delete all orphaned traits from Faraday. Use when you need to clean up traits that are not associated with any source dataset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_DELETE_COHORTTool to permanently delete a cohort from Faraday. Use when you need to remove a cohort that is no longer needed.

Input Parameters

string
required
The UUID of the cohort to delete. This permanently deletes the cohort. Example: ‘856bc7b0-f4d4-433b-9e46-199970d7b78c’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_DELETE_CONNECTIONTool to delete a Faraday connection by its UUID. Use when you need to permanently remove a connection.

Input Parameters

string
required
The UUID of the connection to delete. This permanently removes the connection from Faraday. Ensure no active processes depend on this connection before deletion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_DELETE_DATASETTool to delete a dataset from Faraday. Use when you need to remove a dataset permanently. The operation returns success when the dataset is successfully deleted.

Input Parameters

string
required
The UUID of the dataset to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_DELETE_OUTCOMETool to delete an outcome by its UUID. Use when you need to remove an outcome from Faraday.

Input Parameters

string
required
The UUID of the outcome to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_DELETE_PERSONA_SETTool to delete a persona set. Use when you need to permanently remove a persona set from Faraday. Returns success status and HTTP code 204 on successful deletion.

Input Parameters

string
required
The UUID of the persona set to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_DELETE_PLACETool to delete a place by its UUID. Use when you need to remove a place from the system.

Input Parameters

string
required
The UUID of the place to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_DELETE_SCOPETool to delete a scope by its UUID. Use when you need to permanently remove a scope from the system. Returns 204 status code on successful deletion.

Input Parameters

string
required
The UUID of the scope to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_DELETE_STREAMDelete a stream by its UUID or name. A 404 response is also reported as success, so success does not establish that a stream was deleted by this request.

Input Parameters

string
required
The stream’s UUID or name to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_DELETE_TARGETTool to delete a target by its UUID. Use when you need to remove a target from Faraday.

Input Parameters

string
required
The UUID of the target to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_DELETE_UPLOADPermanently deletes a file from a Faraday dataset directory. Use this when you need to remove an uploaded file from a specific directory. This is a destructive operation that cannot be undone - the file will be permanently removed from the specified directory.

Input Parameters

string
required
The name of an individual data file in a dataset to delete. Must include the file extension (e.g., ‘.csv’, ‘.json’). Example: ‘data_01.csv’, ‘orders_2024.csv’
string
required
A directory of files which can be imported as a single dataset. This is the folder name where the file is stored. Example: ‘abc_orders’, ‘customer_orders’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_DELETE_WEBHOOK_ENDPOINTDelete a Faraday webhook endpoint by its UUID. Returns a success flag and message when the request succeeds.

Input Parameters

string
required
The UUID of the webhook endpoint to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_FORCE_UPDATE_COHORTTool to trigger a rerun for a cohort. Use when you need to force rebuild a cohort’s data.

Input Parameters

string
required
The UUID of the cohort to force update. This triggers a rerun for the cohort. Example: ‘ac030f6a-a728-4fcd-b34a-d5b7ba09d60c’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_FORCE_UPDATE_CONNECTIONTool to trigger a rerun for a Faraday connection. Use when you need to force refresh connection data.

Input Parameters

string
required
The UUID of the connection to trigger a rerun for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_FORCE_UPDATE_DATASETTrigger a rerun for a dataset rather than waiting for its normal update schedule. A successful request queues the dataset for rerun.

Input Parameters

string
required
The UUID of the dataset to force update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_FORCE_UPDATE_OUTCOMETool to trigger a rerun for an outcome resource. Use when you need to force rebuild an outcome, causing it to reprocess and update its predictions.

Input Parameters

string
required
The UUID of the outcome to force update (trigger a rerun).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_FORCE_UPDATE_PERSONA_SETTool to trigger a rerun for a persona set resource. Use when you need to force rebuild a persona set, causing it to reprocess and update its personas.

Input Parameters

string
required
The UUID of the persona set to force update (trigger a rerun).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_FORCE_UPDATE_PLACETool to trigger a rerun for a place. Use when you need to force rebuild a place’s data.

Input Parameters

string
required
The UUID of the place to force update. This triggers a rerun for the place. Example: ‘a1eafa5c-020a-427f-ae18-2d0b3c0fced7’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_FORCE_UPDATE_SCOPETool to trigger a rerun for a scope resource. Use when you need to force rebuild a scope, causing it to reprocess and update its data.

Input Parameters

string
required
The UUID of the scope to force update (trigger a rerun).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_FORCE_UPDATE_STREAMTool to trigger a rerun for a stream. Use when you need to force rebuild a stream’s data.

Input Parameters

string
required
The UUID or name of the stream to force update. This triggers a rerun for the stream. Example: ‘b8907e67-dac8-4fc2-a332-7676f0077dd8’ or ‘orders’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_FORCE_UPDATE_TARGETTool to trigger a rerun for a target. Use when you need to force rebuild a target’s data.

Input Parameters

string
required
The UUID of the target to force update. This triggers a rerun for the target. Example: ‘eb3450c4-f1d3-4edd-8d70-d1b4f7c16348’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_FORCE_UPDATE_TRAITTool to trigger a rerun for a trait. Use when you need to force rebuild a trait’s data.

Input Parameters

string
required
The UUID of the trait to force update. This triggers a rerun for the trait. Example: ‘616aee5f-e544-43ff-a27e-5207248d4056’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_ACCOUNTTool to retrieve detailed information about a Faraday account by its UUID. Use when you need to fetch account details, status, branding, or billing information.

Input Parameters

string
required
The UUID of the account to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_ACCOUNTSTool to list all Faraday accounts accessible by the current user. Use when you need to retrieve account information, check account status, or get account IDs for other operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_ACCOUNTS_BILLINGTool to get billing information about your account. Use when you need to retrieve invoices, payments, or usage information for a specific account.

Input Parameters

string
required
The UUID of an account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_COHORTTool to retrieve a specific cohort by ID. Use when you need to fetch details about a specific cohort.

Input Parameters

string
required
The UUID of the cohort to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_COHORT_ANALYSIS_MEMBERSHIPTool to get cohort membership counts over time for a specific cohort. Use when you need to analyze how cohort membership has changed over days, weeks, and months.

Input Parameters

string
required
The UUID of the cohort to analyze

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_COHORTSTool to list all cohorts in your Faraday account. Use when you need to retrieve the list of customer groups or segments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_CONNECTION_DATASETSTool to retrieve all datasets that use a specific connection. Use when you need to list datasets associated with a connection ID.

Input Parameters

string
required
The UUID of the connection to retrieve datasets for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_CONNECTIONS_TARGETSTool to retrieve all targets that use a specific connection. Use when you need to get a list of all targets associated with a connection ID.

Input Parameters

string
required
The UUID of a connection

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_CURRENT_ACCOUNTTool to retrieve the current account information. Use when you need to get details about the authenticated account, including account ID, name, status, and billing information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_CURRENT_ACCOUNT_BILLINGTool to retrieve billing information about the current account. Use when you need to check invoices, payments, or usage limits for the authenticated Faraday account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_DATASETTool to retrieve a dataset by its UUID. Use when you need to get details about a specific dataset including its configuration, columns, status, and metadata.

Input Parameters

string
required
The UUID of the dataset to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_DATASETS_LOGS_INGRESSTool to retrieve dataset ingress metrics over time. Use when you need to monitor or analyze data ingestion history, track row counts, or review ingress operation status for a specific dataset.

Input Parameters

integer
Number of records to return (pagination)
integer
Number of records to skip for pagination
string
required
UUID of the dataset to retrieve ingress logs for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_FEATURE_STORESTool to list all feature stores. Use when you need to retrieve feature stores from your Faraday account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_GRAPHTool to retrieve the complete dependency graph for all resources on an account. Shows relationships between datasets, cohorts, outcomes, targets, connections, and other resources.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_MARKET_OPPORTUNITY_ANALYSESTool to retrieve all market opportunity analyses from Faraday. Use when you need to view penetration and opportunity metrics in your market.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_OUTCOMETool to retrieve an outcome by its ID. Use when you need to get details about a specific outcome including its configuration, cohorts, status, and performance metrics.

Input Parameters

string
required
The UUID of the outcome to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_OUTCOMESTool to list all outcomes for the account. Use when you need to retrieve configured business objectives and their modeling status. Returns complete list without pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_PERSONA_SETTool to retrieve a persona set by its UUID. Use when you need to access details about a specific customer persona set including its status, configuration, and constituent personas.

Input Parameters

string
required
The UUID of a persona set to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_PERSONA_SET_ANALYSIS_FLOWRetrieve persona membership counts over time for a persona set. This analysis endpoint is deprecated and no longer maintained.

Input Parameters

string
required
The UUID of a persona set

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_PERSONA_SETSTool to list all persona sets. Use when you need to retrieve customer persona sets for analysis or selection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_PERSONA_SETS_ANALYSIS_DIMENSIONSRetrieve analysis dimensions for the personas in a persona set to examine their characteristics and distributions. Results include trait breakdowns, or attribute dimensions for accounts with an identity graph feature store.

Input Parameters

string
required
The UUID of the persona set to retrieve analysis dimensions for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_PLACETool to retrieve a specific place by its UUID. Use when you need to get details about a geospatial area or address set that can be used as a spatial filter.

Input Parameters

string
required
The UUID of the place to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_PLACESList Faraday places used as geospatial filters, with their status and configuration. Address entries are returned without their individual address fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_RECOMMENDERSTool to list all recommenders. Use when you need to retrieve recommender resources that predict future associations based on event streams.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_SCOPETool to retrieve detailed information about a Faraday scope by its UUID. Use when you need to fetch scope configuration, population settings, payload details, or status information.

Input Parameters

string
required
The UUID of the scope to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_SCOPE_ANALYSISTool to get analysis for a scope including outcomes and recommenders with probability distributions. Use when you need to analyze scope performance and understand prediction distributions.

Input Parameters

string
required
The UUID of the scope to get analysis for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_SCOPE_DATASETSTool to retrieve all datasets associated with a Faraday scope. Use when you need to list or view all datasets that are connected to a specific scope.

Input Parameters

string
required
The UUID of the scope to retrieve datasets for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_SCOPE_EFFICACYRetrieve outcome efficacy metrics for a scope, including monthly attainment and performance comparisons. A missing or unrecognized outcomes payload is returned as an empty outcomes list.

Input Parameters

string
required
The UUID of the scope to retrieve efficacy data for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_SCOPE_PAYLOAD_COHORTSTool to get payload cohorts for a specific scope. Use when you need to retrieve the list of cohorts included in a scope’s payload configuration.

Input Parameters

string
required
The UUID of the scope to retrieve payload cohorts for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_SCOPE_PAYLOAD_OUTCOMESRetrieve outcome resources configured in a specific scope’s payload, including their model configuration and available summary metrics.

Input Parameters

string
required
The UUID of the scope to retrieve payload outcomes for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_SCOPE_PAYLOAD_PERSONA_SETSTool to get payload persona sets for a specific scope. Use when you need to retrieve the list of persona sets included in a scope’s payload configuration.

Input Parameters

string
required
The UUID of the scope to retrieve payload persona sets for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_SCOPE_PAYLOAD_RECOMMENDERSTool to retrieve payload recommenders for a specific scope. Use when you need to fetch recommender resources associated with a scope’s payload configuration.

Input Parameters

string
required
The UUID of a scope

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_SCOPE_POPULATION_EXCLUSION_COHORTSTool to get population exclusion cohorts for a scope. Use when you need to retrieve the cohorts that are excluded from a specific scope’s population.

Input Parameters

string
required
The UUID of a scope

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_SCOPES_POPULATION_COHORTSTool to get population cohorts for a specific scope. Use when you need to retrieve the list of cohorts associated with a scope’s population.

Input Parameters

string
required
The UUID of a scope

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_SCOPE_TARGETSTool to get all targets for a specific scope. Use when you need to retrieve export configurations and target details for a scope.

Input Parameters

string
required
The UUID of the scope to retrieve targets for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_STREAMTool to retrieve a stream by its UUID or name. Use when you need to fetch stream details including properties, event counts, and metadata.

Input Parameters

string
required
The stream’s UUID or name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_STREAMSTool to list all streams in your Faraday account. Use when you need to retrieve event streams associated with the account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_STREAMS_ANALYSISTool to get the count of stream events emitted over a time period. Use when you need to analyze stream activity patterns and event volume trends.

Input Parameters

string
required
The UUID of a stream or stream name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_TARGETTool to retrieve a specific target by its UUID from Faraday. Use when you need to fetch details about a target including its configuration, status, and export settings.

Input Parameters

string
required
The UUID of the target to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_TARGETS_ANALYSISTool to retrieve a target’s analysis including geographic distributions and trait breakdowns. Use when you need to understand the composition and characteristics of individuals within a specific target.

Input Parameters

string
required
The UUID of the target to retrieve analysis for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_TRAITTool to retrieve a specific trait by ID. Use when you need to get detailed information about a trait including its type, category, statistical properties, and configuration.

Input Parameters

string
required
The UUID of the trait to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_TRAITS_ANALYSIS_DIMENSIONSTool to retrieve the percentage of the US population that falls into each category of a trait. Use when you need to analyze the distribution of a specific trait across the population.

Input Parameters

string
required
The UUID of the trait to retrieve analysis dimensions for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_TRAITS_CSVTool to retrieve all user-defined and Faraday-provided traits in CSV format. Use when you need to export or analyze trait data in a spreadsheet-compatible format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_UPLOADTool to download a previously uploaded file from a Faraday dataset directory. Use when you need to retrieve the contents of a specific file.

Input Parameters

string
required
The name of an individual data file in a dataset to download. Must include the file extension (e.g., ‘.csv’, ‘.json’). Example: ‘data_01.csv’, ‘sample.csv’
string
required
A directory of files which can be imported as a single dataset. This is the folder name where the file is stored. Example: ‘abc_orders’, ‘test-data’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_UPLOADSTool to retrieve the list of previously uploaded files in Faraday. Use when you need to see uploaded datasets or verify file uploads.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_USAGESTool to retrieve usage statistics for your Faraday account. Use when you need to check current usage and limits for various account features.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_WEBHOOK_ENDPOINTRetrieve a webhook endpoint by its UUID, including its URL, status and enabled events. The signing secret is returned as a placeholder rather than its value.

Input Parameters

string
required
The UUID of a webhook endpoint

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_GET_WEBHOOK_ENDPOINTSTool to list all webhook endpoints configured for the account. Use when you need to retrieve webhook endpoint information including URLs, status, and enabled events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_LIST_ATTRIBUTESTool to list all attributes in the feature store. Use when you need to retrieve the catalog of available attributes for data analysis or feature engineering.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_LIST_CONNECTIONSTool to list all connections configured in Faraday. Use when you need to view available data connections between Faraday and external locations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_LIST_SCOPESTool to list all scopes. Use when you need to retrieve scope configurations for viewing output data instructions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_LIST_TARGETSTool to list all targets in your Faraday account. Use when you need to view export configurations for predictions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_UNARCHIVE_COHORTTool to unarchive a previously archived cohort. Use when you need to restore an archived cohort and optionally its upstream resources.

Input Parameters

string
required
The UUID of the cohort to unarchive. Example: ‘bc4eef1c-be49-4ca6-880f-a34479c7755d’
array
Only allow the following resources (by UUID) to be unarchived. If an upstream resource would be unarchived and is not in this list, throw an error.
boolean
When unarchiving a resource, if this is set to true, unarchive the resource and all its upstream resources. If false, and there are upstream resources that would be unarchived, throw an error.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_UNARCHIVE_DATASETSTool to unarchive a dataset in Faraday. Use when you need to restore an archived dataset for active use. Optionally cascades to upstream resources.

Input Parameters

array
Only allow the following resources to be archived/unarchived. If a downstream or upstream resource would be archived/unarchived, and is not in this list, throw an error.
string
required
The UUID of the dataset to unarchive.
boolean
When unarchiving a resource, if this is set to true, unarchive the resource and all its upstream resources. If false, and there are upstream resources that would be unarchived, throw an error.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_UNARCHIVE_OUTCOMEUnarchive an outcome in Faraday to restore updates, optionally cascading to upstream resources.

Input Parameters

array
Only allow the following resource UUIDs to be unarchived. If an upstream resource would be unarchived and is not in this list, an error will be thrown. Cannot be used together with cascade_to_all.
string
required
The UUID of the outcome to unarchive. Unarchiving restores updates to the outcome. Example: ‘15be73ec-1525-4d5c-a96a-e644c93d00d8’
boolean
When true, unarchive the outcome and all its upstream resources. When false, throw an error if there are upstream resources that would be unarchived. Cannot be used together with cascade_to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_UNARCHIVE_PERSONA_SETSTool to unarchive a previously archived persona set. Use when you need to restore an archived persona set and optionally its upstream resources.

Input Parameters

array
Only allow the following resources (by UUID) to be unarchived. If an upstream resource would be unarchived and is not in this list, throw an error.
boolean
When unarchiving a resource, if this is set to true, unarchive the resource and all its upstream resources. If false, and there are upstream resources that would be unarchived, throw an error.
string
required
The UUID of the persona set to unarchive. Example: ‘8505e525-128c-4ede-a279-85f372aa6aaf’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_UNARCHIVE_PLACESTool to unarchive a previously archived place. Use when you need to restore an archived place and optionally its upstream resources.

Input Parameters

string
required
The UUID of the place to unarchive. Example: ‘a1eafa5c-020a-427f-ae18-2d0b3c0fced7’
array
Only allow the following resources (by UUID) to be unarchived. If an upstream resource would be unarchived and is not in this list, throw an error.
boolean
When unarchiving a resource, if this is set to true, unarchive the resource and all its upstream resources. If false, and there are upstream resources that would be unarchived, throw an error.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_UNARCHIVE_SCOPETool to unarchive a previously archived scope. Use when you need to restore an archived scope and optionally its upstream resources.

Input Parameters

string
required
The UUID of the scope to unarchive. Example: ‘fce4d114-9516-4e8c-a92e-e1ed13d5369d’
array
Only allow the following resource UUIDs to be unarchived. If an upstream resource would be unarchived and is not in this list, an error will be thrown. Cannot be used together with cascade_to_all.
boolean
When true, unarchive the scope and all its upstream resources. When false, throw an error if there are upstream resources that would be unarchived. Cannot be used together with cascade_to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_UNARCHIVE_STREAMTool to unarchive a stream in Faraday. Use when you need to restore an archived stream for active use. Optionally cascades to upstream resources.

Input Parameters

array
Only allow the following resources to be unarchived. If an upstream resource would be unarchived, and is not in this list, throw an error.
boolean
When unarchiving a resource, if this is set to true, unarchive the resource and all its upstream resources. If false, and there are upstream resources that would be unarchived, throw an error.
string
required
The UUID or name of the stream to unarchive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_UNARCHIVE_TRAITTool to unarchive a trait. Use when you need to restore an archived trait and optionally its upstream resources.

Input Parameters

string
required
The UUID of the trait to unarchive
array
Only allow the following resource UUIDs to be unarchived. If an upstream resource would be unarchived, and is not in this list, throw an error.
boolean
When unarchiving a resource, if this is set to true, unarchive the resource and all its upstream resources. If false, and there are upstream resources that would be unarchived, throw an error.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_UPDATE_ACCOUNTTool to update an account’s name or branding settings. Use when you need to modify account properties using JSON Merge Patch semantics.

Input Parameters

string
The name of the account. Must be non-empty and max 64 characters.
object
Whitelabel branding configuration for the account
string
required
The UUID of the account to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_UPDATE_COHORTTool to update a cohort’s configuration using JSON Merge Patch semantics. Use when you need to modify cohort properties like name, filters, or conditions.

Input Parameters

string
Human-readable label for this cohort. Must be non-empty and max 64 characters.
array
List of traits to filter cohort membership. Set to null to clear.
boolean
Whether to show the Cohort in Explore, the map view on https://app.faraday.ai. This will slow down Cohort builds.
object
Recency condition for event-based filtering.
string
required
The UUID of the cohort to update
number
Max count for this cohort’s config
number
Max value for this cohort’s config
number
Min count for this cohort’s config
number
Min value for this cohort’s config
string
The name field of the stream from which to build this cohort. Set to null to clear.
array
List of places to use to spatially filter Cohort membership. Set to null to clear.
array
List of stream properties to filter cohort membership on. The stream properties must be for the same stream set as the cohort stream_name. Nulls are excluded unless explicitly requested with _null: true. Set to null to clear.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_UPDATE_CONNECTIONTool to update a Faraday connection’s name or options. Use when you need to modify connection properties using JSON Merge Patch semantics.

Input Parameters

string
A user-friendly name of the connection. Max 64 characters, must be non-empty.
object
Connection-specific options that vary by connection type.
string
required
The UUID of the connection to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_UPDATE_DATASETTool to update a dataset configuration using JSON Merge Patch semantics. Use when you need to modify dataset properties like name, identity sets, output configurations, or privacy settings.

Input Parameters

string
An identifying name for this dataset.
object
Dataset connection options. Must specify ‘type’ field for the connection type.
boolean
A dataset in preview mode will only detect columns and produce a data preview, but not ingest the data. Set to null to clear.
string
Privacy settings: ‘suppress’ (data can be used for modeling but excluded from pipelines) or ‘delete’ (data cannot be used for modeling and excluded from pipelines). Set to null to clear.
string
required
The UUID of the dataset to update.
object
A mapping of identity set names to identity set objects. Describes all the logical groupings of personally-identifiable information present in the dataset. Set value to null to clear.
array
Also known as the “primary key” of the dataset. A column or set of columns that uniquely identify an input row. Set to null to clear.
object
A mapping of trait name to trait definition. Set to null to clear.
object
Describes how to transform the dataset into one or more streams. Set to null to clear.
array
Which identity providers to use for matching, in order of priority. Set to null to clear.
string
A column specifying a date associated with a record. Set to null to clear.
string
Deprecated: use reference_key_columns instead. The name of the column that references an ID from an external system. Set to null to clear.
array
The names of columns that reference IDs from an external system. Set to null to clear.
array
An array-based approach to transforming datasets into streams. Each element specifies a stream_name and properties configuration. Set to null to clear.
object
If specified, all columns that are not excluded will be output as traits. Must include ‘exclude’ field with list of column names. Set to null to clear.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_UPDATE_OUTCOMEUpdate an outcome’s configuration by ID, including its name, cohorts, bias mitigation, feature blocklist, prediction mode, predictors, or preview status. Null values are omitted and cannot be used to clear fields.

Input Parameters

string
Human-readable label for this outcome. Each outcome must have a unique name. Max 64 characters, must not be empty or only whitespace.
boolean
An outcome in preview mode will not build until preview is turned off. Set to null to clear.
string
required
The UUID of the outcome to update.
object
Configuration for features used during modeling.
object
Bias mitigation configuration for age and gender dimensions.
string ("auto" | "static")
Prediction mode for outcome modeling.
array
Field or category names that should not be considered for this outcome, primarily for Responsible AI purposes. Set to null to clear.
string
A cohort of people who could attain or attrite the desired outcome. If not specified, uses the US population. Set to null to clear.
string
A cohort of counterexamples - people who have clearly failed to attain the outcome. This cohort is optional. Set to null to clear.
string
A cohort of people who have attained the desired outcome (e.g., existing customers if predicting prospect to customer transition).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_UPDATE_PERSONA_SETUpdate a persona set’s name, cluster count, or preview mode; the deprecated explore setting can also be submitted but has no effect. Null values are omitted and cannot clear settings.

Input Parameters

string
Human-readable label for this persona set. Must be non-empty and max 64 characters.
boolean
Whether to show the persona set in Explore, the map view on https://app.faraday.ai. This will slow down persona set builds. Set to null to clear this setting.
boolean
A persona set in preview mode will not build until preview is turned off. Set to null to clear this setting.
string
required
The UUID of the persona set to update
integer
Specify the exact number of clusters (i.e. personas) in the persona set. By default, the optimal value is determined automatically. Setting this requires external knowledge and should only be done when the use-case necessitates a specific number. Set to null to clear and use automatic determination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_UPDATE_PLACEUpdate a place’s name, addresses, or GeoJSON geometry. Null address and geometry values are omitted rather than sent to clear the existing values.

Input Parameters

string
Human-readable label for this place. Names must be unique. Uniqueness is case-insensitive.
object
A GeoJSON Geometry, as defined in the GeoJSON specification. The longitude and latitude units are in decimal degrees, using the WGS84 coordinate reference system (SRID 4326). Set to null to clear geojson.
string
required
The UUID of the place to update
array
List of addresses to be geocoded. Set to null to clear addresses, or provide a list to overwrite existing addresses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_UPDATE_SCOPEUpdate a Faraday scope’s name, payload settings, population cohorts, or preview status. When payload or population is supplied, omitted fields within that object are sent as null and may clear existing settings.

Input Parameters

string
Human-readable label for this scope. Each scope must have a unique name (max length: 64 characters, must be non-empty).
object
The data to include for each person in this scope (for PATCH requests)
boolean
A preview scope provides only a limited number of output records, but it is not billed.
string
required
The UUID of the scope to update
object
The people to include in a scope (for PATCH requests)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_UPDATE_STREAMUpdate a stream’s metadata or properties by UUID or name using JSON Merge Patch. Top-level fields supplied as null are omitted rather than cleared.

Input Parameters

string
A billing tier for the stream property. Set to null to clear this field.
string
A category describing the type of stream property. Set to null to clear this field.
string
A human-readable name for the stream. Set to null to clear this field.
boolean
Whether the stream is deprecated. Set to null to clear this field.
object
Columns in your data that you want to associate with this event. The key is the name of the property, and the value is metadata about the property. Set to null to clear this field.
string
A description of the stream. Set to null to clear this field.
string
Notes about the deprecation of the stream. Set to null to clear this field.
string
required
The stream’s UUID or name to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_UPDATE_TARGETTool to update a target’s configuration in Faraday. Use when you need to modify target properties using JSON Merge Patch semantics.

Input Parameters

string
A user-friendly name of the target (max length: 64 characters)
object
Limit configuration for target rows
object
Filter configuration for target rows
object
Target export configuration options
string
required
The UUID of the target to update
object
Deprecated: use custom_structure. Explicit mapping of columns that should be included in the target export. Set to null to clear
string
If this is a replication (externally-hosted) target, the UUID of a connection. Set to null to clear
boolean
Whether to use human-readable column names instead of machine-readable format with underscored uuids. Set to null to clear
object
Target representation configuration
object
Configuration for the analysis of the target
array
Custom structure transformations to override the default selection, order, and name of exported columns. Set to null to clear

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_UPDATE_TRAITTool to update a trait’s properties using JSON Merge Patch semantics. Use when you need to modify trait metadata like description, literate name, lookup table, statistical type, or unit.

Input Parameters

string
For numeric types, in what units is the data stored. Set to null to clear this value.
string
A more human-consumable version of the name of this field. Set to null to clear this value.
string
required
The UUID of the trait to update
string
Information about this field. Set to null to clear this value.
object
A mapping of the input values used in modeling, to how they should be displayed in reports. Set to null to clear this value.
string ("categorical" | "multicategorical" | "ordinal" | "nominal")
Statistical type describing the nature of data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FARADAY_UPDATE_WEBHOOK_ENDPOINTSTool to update a webhook endpoint’s configuration. Use when you need to modify the status, URL, or enabled events for an existing webhook endpoint.

Input Parameters

string
The URL of the webhook endpoint.
string ("enabled" | "disabled")
The status of the webhook endpoint.
array
The event types to enable for this endpoint. Available events: ‘resource.errored’ (when a resource encounters an error) and ‘resource.ready_with_update’ (when a resource is ready with updates).
string
required
The UUID of the webhook endpoint to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not