X

Actions

Home > Application Reference > Percolate

Jump to a Section

Actions

  • Create Campaign

    This action allows you to create a new campaign.

    You can find the API details here.

    Options:

    • Tenant (dropdown): dynamically generated list of tenants to choose from
    • Team (dropdown): dynamically generated list of teams to choose from

    Inputs:

    • Fields
      • Title (string): Title or Description must be provided
      • Description (string): Title or Description must be provided
      • Start At (string): The date when the campaign is scheduled to start, e.g. 2019-01-01
      • End At (string): The date when the campaign is scheduled to end, e.g. 2020-01-01
      • Budget Currency (string): Standard currencies defined by ISO_4217
      • Budget Amount (string): Budget Currency and Budget Amount must be specified together if you want to provide budget info
      • Term IDs (collection): An array of the terms associated with the campaign
      • Assignee ID (string): The ID of user who is assigned to the campaign
      • Approval Group ID (string): The approval group ID
      • Copy From ID (string): Creates a copy of the specified campaign when a campaign UID is specified or creates a campaign from a campaign template when a campaign template UID is specified
      • Copy Section Types (collection): Copy campaign sections matching given types
      • Platform IDs (collection): An array of the platforms associated with the campaign
      • Post Workflow IDs (collection): An array of the production workflows associated with the campaign
      • Production Workflow ID (string): ID of the production workflow that the campaign is attached to
      • Production Workflow IDs (collection): An array of the production workflows associated with the campaign
      • Thumbnail Asset ID (string): An asset ID, a legacy video ID or a legacy image ID

    Outputs:

    • Campaign
      • Campaign ID (string): The unique campaign ID
      • Team ID (string): A license ID
      • Title (string): The campaign title
      • Description (string): A short description of the campaign
      • Start At (string): The date when the campaign is scheduled to start, e.g. 2019-01-01
      • End At (string): The date when the campaign is scheduled to end, e.g. 2020-01-01
      • Budget Currency (string): Standard currencies defined by ISO_4217
      • Budget Amount (string): Budget Currency and Budget Amount must be specified together if you want to provide budget info
      • Term IDs (string): An array of the terms associated with the campaign
      • Assignee ID (string): The ID of user who is assigned to the campaign
      • Created At (string): An absolute datetime indicating when this resource was created
      • Updated At (string): An absolute datetime indicating when this resource was last modified
      • Ordinal (string): Default ordering of the task relative to others with the same subject
      • Parent ID (string): The unique campaign ID
      • Root ID (string): The unique campaign ID
      • Platform IDs (collection): An array of the platforms associated with the campaign
      • Post Workflow IDs (collection): An array of the production workflows associated with the campaign
      • Production Workflow ID (string): ID of the production workflow that the campaign is attached to
      • Production Workflow IDs (collection): An array of the production workflows associated with the campaign
      • Thumbnail Asset ID (string): An asset ID, a legacy video ID or a legacy image ID
      • Topic IDs (collection): An array of the topics associated with the campaign
      • Approval IDs (collection): An array of approval IDs

  • Custom API Action

    This action allows you to make a custom, authenticated HTTP call to the Percolate API.

    NOTE: If you have no experience working with API calls this may be a challenge, however this card is highly customizable. Good luck, and it may help if you refer to the documentation!

    Options

    • Request Type (dropdown): your available HTTP request methods. There are 5 supported HTTP request methods (sometimes called verbs) in custom API calls:

      • GET: retrieves data from a web server based on your parameters. GET requests a representation of the specified resource, and if successful will receive a 200 OK response message with the requested content. Additional documentation here.

      • POST: sends data to a web server based on your parameters. POST requests include actions like uploading a file. Multiple POST’s may result in a different outcome than a single POST, so you should be cautious about unintentionally sending multiple POST’s. If a POST is successful, you will receive a 200 OK response message. Additional documentation here.

      • PUT: sends data to a location in the web server based on your parameters. PUT requests include actions like uploading a file. The difference between a PUT and POST is that PUT is idempotent, meaning that the result of a single successful PUT is the same as many identical PUT’s. If a PUT is successful, you will receive a 200 response message (usually 201 or 204). Additional documentation here.

      • PATCH: applies partial modifications to a resource on a web server based on your parameters. PATCH is not idempotent, meaning that the result of multiple PATCH’s could have unintended consequences. If a PUT is successful, you will receive a 200 response message (usually 204). Additional documentation here.

      • DELETE: deletes the specified resource from the web server based on your parameters (if the resource exists). If a DELETE is successful, you will receive a 200 OK response message. Additional documentation here.

    Input Data

    • Relative URL (text): the address on the web server you are attempting to interact with. Relative URL means that you don’t have to explicitly specify the protocol at the beginning of the URL (such as “http://“). This suggests to the web server that the interaction is occurring on the server (in this instance). With this Custom API Action the user needs to specify the API version being accessed and add following ‘/’ characters when required.

      Example: /api/v5/campaign/

    • Query (object or text): JSON object that determines the action taken at the URL.

      Example: {"name":"something-urgent"}

    • Headers (object): JSON that determines the content type of the request. This will usually be a replica of the example below.

      Example: {"Content-type":"application/json"}

    Output Data

    • Status Code (Number): the success or failure of your HTTP request. Here is a list of all status codes.

    • Headers (object): a more detailed context for the response/status code that doesn’t relate to the output body. Not all headers that appear in a response header are response headers, meaning that some are unlikely to be useful to you.

    The response headers are dependent on the HTTP request you choose in options.

    • Body (object): depending on the HTTP request you chose in Options, you may receive some data back. That data, such as the data from a GET request, will be contained in this Body object.

  • Read Campaign

    This action allows you to get the details about a campaign using the campaign ID.

    You can find the API details here.

    Inputs:

    • Read By
      • Campaign ID (string): The unique campaign ID, e.g.: campaign:681455

    Outputs:

    • Campaign
      • Campaign ID (string): The unique campaign ID
      • Team ID (string): A license ID
      • Title (string): The campaign title
      • Description (string): A short description of the campaign
      • Start At (string): The date when the campaign is scheduled to start, e.g. 2019-01-01
      • End At (string): The date when the campaign is scheduled to end, e.g. 2020-01-01
      • Budget Currency (string): Standard currencies defined by ISO_4217
      • Budget Amount (string): Budget Currency and Budget Amount must be specified together if you want to provide budget info
      • Term IDs (string): An array of the terms associated with the campaign
      • Assignee ID (string): The ID of user who is assigned to the campaign
      • Created At (string): An absolute datetime indicating when this resource was created
      • Updated At (string): An absolute datetime indicating when this resource was last modified
      • Ordinal (string): Default ordering of the task relative to others with the same subject
      • Parent ID (string): The unique campaign ID
      • Root ID (string): The unique campaign ID
      • Platform IDs (collection): An array of the platforms associated with the campaign
      • Post Workflow IDs (collection): An array of the production workflows associated with the campaign
      • Production Workflow ID (string): ID of the production workflow that the campaign is attached to
      • Production Workflow IDs (collection): An array of the production workflows associated with the campaign
      • Thumbnail Asset ID (string): An asset ID, a legacy video ID or a legacy image ID
      • Approval IDs (collection): An array of approval IDs

  • Search Campaigns

    This action allows you to search for a campaign or multiple campaigns matching one or more fields.

    You can find the API details here.

    Options:

    • Result Set (dropdown): First matching campaign or All matching campaigns

    Inputs:

    • Search
      • Order By (string): e.g. created_at, end_at, start_at, title, updated_at
      • Order Direction (string): Control order direction, asc or desc
      • Limit (number): Default to 100, limit the number of paginated results
      • Offset (number): A 0-based offset to adjust the pagination window
      • Keywords (string): Keyword values to search for on campaigns
      • Extend Scopes? (boolean): Default to false, whether to look inside any child scopes in addition to the supplied ones
      • Team IDs (string): A CSV of license IDs to filter by
      • Campaign IDs (string): A CSV of unique IDs to filter by
      • Title (string): Keyword values to search for on campaign titles
      • Has Dates? (string): true or false, filter campaigns with or without dates
      • Access Scopes (string): Filter objects owned by the scope itself and/or shared from other scopes
      • Start At From (string): Filter campaigns with start_at on or after date, e.g. 2020-02-02
      • End At To (string): Filter campaigns with end_at on or before date, e.g. 2020-02-02
      • Start At Range From (string): inclusive, e.g. 2020-02-02. Note: Need to specify both bounds of start_at_range or not at all
      • Start At Range To (string): exclusive, e.g. 2020-02-02. Note: Need to specify both bounds of start_at_range or not at all
      • End At Range From (string): inclusive, e.g. 2020-02-02. Note: Need to specify both bounds of end_at_range or not at all
      • End At Range To (string): exclusive, e.g. 2020-02-02. Note: Need to specify both bounds of end_at_range or not at all
      • Term IDs (string): A CSV of unique term IDs to filter by
      • Platform IDs (dropdown): no_workflow, incomplete, approved or rejected
      • Approval Workflow Participant User IDs (string): A CSV of user IDs to filter by workflows where a user is a participant
      • Approval Workflow Participant Feedbacks (dropdown): pending, approved, or rejected, required when using Approval Workflow Participant User IDs
      • Approval Workflow Participant In Step (dropdown): current or any, required when using Approval Workflow Participant User IDs
      • Assignee IDs (string): A CSV of user IDs to filter campaigns that are assigned to those users
      • Assignment Statuses (string): Filter campaigns if they are unassigned, assigned or both
      • Production Workflow From Date (string): Filter campaigns with production workflow ending at or after this date, e.g. 2020-02-02
      • Production Workflow To Date (string): Filter campaigns with production workflow starting at or before this date, e.g. 2020-02-02

    Outputs:

    Will return either a single campaign or a list of campaigns depending on the ‘Result Set’ selection in the options.

    • Campaign
      • Campaign ID (string): The unique campaign ID
      • Team ID (string): A license ID
      • Title (string): The campaign title
      • Description (string): A short description of the campaign
      • Start At (string): The date when the campaign is scheduled to start, e.g. 2019-01-01
      • End At (string): The date when the campaign is scheduled to end, e.g. 2020-01-01
      • Budget Currency (string): Standard currencies defined by ISO_4217
      • Budget Amount (string): Budget Currency and Budget Amount must be specified together if you want to provide budget info
      • Term IDs (string): An array of the terms associated with the campaign
      • Assignee ID (string): The ID of user who is assigned to the campaign
      • Created At (string): An absolute datetime indicating when this resource was created
      • Updated At (string): An absolute datetime indicating when this resource was last modified
      • Ordinal (string): Default ordering of the task relative to others with the same subject
      • Parent ID (string): The unique campaign ID
      • Root ID (string): The unique campaign ID
      • Platform IDs (collection): An array of the platforms associated with the campaign
      • Post Workflow IDs (collection): An array of the production workflows associated with the campaign
      • Production Workflow ID (string): ID of the production workflow that the campaign is attached to
      • Production Workflow IDs (collection): An array of the production workflows associated with the campaign
      • Thumbnail Asset ID (string): An asset ID, a legacy video ID or a legacy image ID
      • Topic IDs (collection): An array of the topics associated with the campaign
      • Approval IDs (collection): An array of approval IDs

  • Update Campaign

    This action allows you to update an existing campaign using the campaign ID.

    You can find the API details here.

    Note: empty fields won’t be updated, but will be kept as the existing values.

    Inputs:

    • Update By

      • Campaign ID (string): The unique campaign ID, e.g.: campaign:681455

    • Fields

      • Team ID (string): The license ID
      • Title (string): The campaign title
      • Description (string): A short description of the campaign
      • Start At (string): The date when the campaign is scheduled to start, e.g. 2019-01-01
      • End At (string): The date when the campaign is scheduled to end, e.g. 2020-01-01
      • Budget Currency (string): Standard currencies defined by ISO_4217
      • Budget Amount (string): Budget Currency and Budget Amount must be specified together if you want to provide budget info
      • Term IDs (collection): An array of the terms associated with the campaign
      • Assignee ID (string): The ID of user who is assigned to the campaign
      • Approval Group ID (string): The approval group ID
      • Platform IDs (collection): An array of the platforms associated with the campaign
      • Post Workflow IDs (collection): An array of the production workflows associated with the campaign
      • Production Workflow ID (string): ID of the production workflow that the campaign is attached to
      • Production Workflow IDs (collection): An array of the production workflows associated with the campaign
      • Thumbnail Asset ID (string): An asset ID, a legacy video ID or a legacy image ID

    Outputs:

    • Campaign
      • Campaign ID (string): The unique campaign ID
      • Team ID (string): The license ID
      • Title (string): The campaign title
      • Description (string): A short description of the campaign
      • Start At (string): The date when the campaign is scheduled to start, e.g. 2019-01-01
      • End At (string): The date when the campaign is scheduled to end, e.g. 2020-01-01
      • Budget Currency (string): Standard currencies defined by ISO_4217
      • Budget Amount (string): Budget Currency and Budget Amount must be specified together if you want to provide budget info
      • Term IDs (string): An array of the terms associated with the campaign
      • Assignee ID (string): The ID of user who is assigned to the campaign
      • Created At (string): An absolute datetime indicating when this resource was created
      • Updated At (string): An absolute datetime indicating when this resource was last modified
      • Ordinal (string): Default ordering of the task relative to others with the same subject
      • Parent ID (string): The unique campaign ID
      • Root ID (string): The unique campaign ID
      • Platform IDs (collection): An array of the platforms associated with the campaign
      • Post Workflow IDs (collection): An array of the production workflows associated with the campaign
      • Production Workflow ID (string): ID of the production workflow that the campaign is attached to
      • Production Workflow IDs (collection): An array of the production workflows associated with the campaign
      • Thumbnail Asset ID (string): An asset ID, a legacy video ID or a legacy image ID
      • Topic IDs (collection): An array of the topics associated with the campaign
      • Approval IDs (collection): An array of approval IDs

  • Update Metadata Fields

    This action allows you to update the metadata fields for a campaign, an asset, a content, a task or an intake request.

    You can find the API details here and here.

    Note: Additional fields may be available depending on the connection and options you choose.

    Options:

    • Object Type (dropdown): Asset, Campaign, Content, Task, or Intake Request
    • Tenant (dropdown): dynamically generated list of tenants to choose from
    • Team (dropdown): dynamically generated list of teams to choose from
    • Schema (dropdown): dynamically generated list of schemas to choose from

    Inputs:

    • Object
      • Object ID (string): The unique campaign ID, asset ID, content ID, task ID or intake request ID, e.g.: campaign:681455
    • Dynamically generated custom fields

    Outputs:

    • Dynamically generated custom fields
    • Others
      • Metadata ID (string): The object metadata ID
      • Object ID (string): The resource ID
      • Schema ID (string): The schema ID
      • Team ID (string): The license ID
      • Created At (string): An absolute datetime indicating when this resource was created
      • Updated At (string): An absolute datetime indicating when this resource was updated