GuidesChangelogAPI Reference

Giving an App Access to Data

Percolate capabilities drive which endpoints and data an app is authorized to access. To enable such access, capabilities must be defined under the App manifest’s capabilities field.

Suggest Edits

Example:

{
    "capabilities": [
        "post:read",
        "brief:read",
        "post:update",
        "brief:update",
        "media:read"
    ]
}

Capabilities

Asset

Upload assets

description: Ability to upload assets
code: asset:upload
implies:

  • approval:pool:read
  • approval:post:read

Upload assets without approval

description: Ability to upload an asset to the media library without approval
code: media:add-asset
implies:

  • media:create

Copy assets

description: Ability to copy media residing in the media library to a license/team
code: media:copy
implies:

  • media:read

Upload assets

description: Ability to upload media to the media library or ingest an image by URL
code: media:create
implies:

  • asset:upload
  • media:metadata:create
  • media:read

Delete assets

description: Ability to delete media residing in the media library
code: media:delete
implies:

  • media:metadata:delete
  • media:read

Download assets

description: Ability to download media from the media library
code: media:download
implies:

  • media:read

Use getty images

description: Ability to search and save royalty-free media from Getty Images
code: media:getty:view
implies:

  • media:create
  • media:read

Create media metadata

description: Create media metadata
code: media:metadata:create
implies:

  • media:read
  • schema:read

Delete media metadata

description: Delete media metadata
code: media:metadata:delete
implies:

  • media:read
  • schema:read

Read media metadata

description: Read media metadata
code: media:metadata:read
implies:

  • schema:read

Update asset metadata

description: Ability to update metadata for media residing in the media library
code: media:metadata:update
implies:

  • media:read
  • schema:read

View assets

description: Ability to view assets
code: media:read
implies:

  • folders:read
  • license:read
  • media:metadata:read
  • pageproof_template:read
  • schema:read

View trashcan and restore assets

description: Ability to view the trashcan and restore assets
code: media:restore
implies:

  • folders:delete
  • folders:metadata:update
  • media:delete
  • media:metadata:update
  • media:read
  • trashcan:read

Use external media service

description: Available to post External Media Service assets
code: media:service:view
implies:

  • media:create
  • media:read

Use shutterstock images

description: Ability to post Shutterstock images
code: media:shutterstock:view
implies:

  • media:create
  • media:read

Edit assets

description: Ability to edit media residing in the media library
code: media:update
implies:

  • license:publishing:settings:read
  • media:metadata:update
  • media:read
  • term:create

Campaign

Copy campaigns

description: Ability to copy campaigns
code: brief:copy
implies:

  • brief:read
  • post:copy

Create a new campaign

description: Ability to view all campaigns
code: brief:create
implies:

  • brief:metadata:create
  • brief:read

Delete campaigns

description: Ability to delete all campaigns
code: brief:delete
implies:

  • brief:metadata:delete
  • brief:read

Edit campaigns

description: Ability to edit all campaigns
code: brief:edit
implies:

  • asset:upload
  • brief:metadata:update
  • brief:read

Create brief metadata

description: Ability to create metadata for brief
code: brief:metadata:create
implies:

  • schema:read

Delete brief metadata

description: Ability to delete brief metadata
code: brief:metadata:delete
implies:

  • schema:read

Read brief metadata

description: Ability to read brief metadata
code: brief:metadata:read
implies:

  • schema:read

Update brief metadata

description: Ability to update brief metadata
code: brief:metadata:update
implies:

  • schema:read

View campaigns

description: Ability to view all campaigns
code: brief:read
implies:

  • approval:post:read
  • brief:metadata:read
  • campaign_template:read
  • license:publishing:settings:read
  • media:read
  • production_workflow:read
  • saved_view:read

Intake Request

Create an intake request

description: Ability to create an intake request
code: intake_request:create
implies:

  • intake_request:metadata:create
  • intake_request:read

Delete an intake request

description: Ability to delete an intake request
code: intake_request:delete
implies:

  • intake_request:metadata:delete
  • intake_request:read

Fulfill an intake request

description: Ability to fulfill an intake request
code: intake_request:fulfill
implies:

  • intake_request:team:read
  • intake_request:team:update

Create intake request metadata

description: Create intake request metadata
code: intake_request:metadata:create
implies:

  • schema:read

Delete intake request metadata

description: Delete intake request metadata
code: intake_request:metadata:delete
implies:

  • schema:read

Read intake request metadata

description: Read intake request metadata
code: intake_request:metadata:read
implies:

  • schema:read

Update intake request metadata

description: Update intake request metadata
code: intake_request:metadata:update
implies:

  • schema:read

Read an intake request

description: Ability to read an intake request
code: intake_request:read
implies:

  • intake_request:metadata:read
  • license_channel:read

Delete a team intake request

description: Ability to delete a team intake request
code: intake_request:team:delete
implies:

  • intake_request:delete

Read team intake request

description: Ability to read a team intake request
code: intake_request:team:read
implies:

  • intake_request:read

Update a team intake request

description: Ability to update a team intake request
code: intake_request:team:update
implies:

  • intake_request:update

Update an intake request

description: Ability to update an intake request
code: intake_request:update
implies:

  • intake_request:metadata:update
  • intake_request:read

Content

Copy content

description: Ability to copy content
code: post:copy
implies:

  • media:copy
  • post:read

Compose content

description: Ability to make new content
code: post:create
implies:

  • approval:pool:read
  • asset:upload
  • post:metadata:create
  • post:read
  • targeting:create

Delete content

description: Ability to remove existing content
code: post:delete
implies:

  • post:metadata:delete
  • post:read

Create post metadata

description: Create post metadata
code: post:metadata:create
implies:

  • schema:read

Delete post metadata

description: Delete post metadata
code: post:metadata:delete
implies:

  • schema:read

Read post metadata

description: Read post metadata
code: post:metadata:read
implies:

  • schema:read

Update post metadata

description: Update post metadata
code: post:metadata:update
implies:

  • schema:read

Create promotion request

description: Ability to request promotion on content
code: post:promotion_request:create
implies:

  • post:promotion_request:read

Delete promotion request

description: Ability to delete promotion request on content
code: post:promotion_request:delete
implies:

  • post:promotion_request:read

Update promotion request

description: Ability to update requested promotion(s).
code: post:promotion_request:edit
implies:

  • post:promotion_request:read

Read promotion request

description: Ability to read content's requested promotion(s).
code: post:promotion_request:read

Publish without approval

description: Ability to publish to a platform without approval
code: post:publish
implies:

  • post:create

View content

description: Ability to view content
code: post:read
implies:

  • approval:pool:read
  • approval:post:read
  • license_channel:read
  • license:publishing:settings:read
  • media:read
  • post:metadata:read
  • post:promotion_request:read
  • preference:read
  • preview_format:read
  • preview_template:read
  • production_workflow:read
  • saved_view:read
  • schema:read
  • targeting:read
  • webhook:read

Submit a new item for approval

description: Ability to submit a new item for Approval
code: post:submit-for-approval
implies:

  • post:read

Update content

description: Ability to modify an existing content
code: post:update
implies:

  • asset:upload
  • post:metadata:update
  • post:read
  • targeting:create
  • targeting:update

Task

Create tasks

description: Ability to create tasks
code: task:create
implies:

  • task_template:read
  • task:metadata:create
  • task:read

Delete tasks

description: Ability to delete tasks
code: task:delete
implies:

  • task:metadata:delete
  • task:read

Create task metadata

description: Ability to create metadata for task
code: task:metadata:create
implies:

  • schema:read

Delete task metadata

description: Ability to delete task metadata
code: task:metadata:delete
implies:

  • schema:read

Read task metadata

description: Ability to read task metadata
code: task:metadata:read
implies:

  • schema:read

Update task metadata

description: Ability to update task metadata
code: task:metadata:update
implies:

  • schema:read

View tasks

description: Ability to read tasks
code: task:read
implies:

  • task:metadata:read

View team tasks

description: Ability to access team tasks in Task Center
code: task:team:read
implies:

  • task:read

Update tasks

description: Ability to update tasks
code: task:update
implies:

  • task:metadata:update
  • task:read

Channel

Create custom channels

description: Create custom channel settings
code: custom_channel:create
implies:

  • custom_channel:read

Delete custom channel

description: Delete custom channel settings associated with a custom platform
code: custom_channel:delete
implies:

  • custom_channel:read

View custom channels

description: View custom channel settings associated with a custom platform
code: custom_channel:read

Update custom channels

description: Update custom channels settings associated with a custom platform
code: custom_channel:update
implies:

  • custom_channel:read

Create license channels

description: Create license channel settings for a license
code: license_channel:create
implies:

  • license_channel:metadata:create
  • license_channel:read

Delete license channels

description: Delete license channels settings for a license
code: license_channel:delete
implies:

  • license_channel:metadata:delete
  • license_channel:read

Create license channel metadata

description: Create license_channel metadata
code: license_channel:metadata:create
implies:

  • schema:read

Delete license channel metadata

description: Delete license_channel metadata
code: license_channel:metadata:delete
implies:

  • schema:read

Read license channel metadata

description: Read license_channel metadata
code: license_channel:metadata:read
implies:

  • schema:read

Update license channel metadata

description: Update license_channel metadata
code: license_channel:metadata:update
implies:

  • schema:read

View license channels

description: View license channel settings for a license
code: license_channel:read
implies:

  • license_channel:metadata:read

Update license channels

description: Update license channels settings for a license
code: license_channel:update
implies:

  • license_channel:metadata:update
  • license_channel:read

Platform

Manage platform

description: Ability update/delete platforms
code: platform:manage

Activity

Read activity

description: Ability to read activity
code: activity:read

Analytics

View content channels or monitoring analytics

description: Ability to view analytics measurements associated with content, channels or monitoring queries
code: analytics:read

App Auth Config

Create an app auth config

description: Create an app auth config
code: app_auth_config:create

Delete an app auth config

description: Delete an app auth config
code: app_auth_config:delete

Read an app auth config

description: Read an app auth config
code: app_auth_config:read

Update an app auth config

description: Update an app auth config
code: app_auth_config:update

App Installation

Create app installation

description: Ability to create app_installations
code: app_installation:create
implies:

  • app_installation:read

Delete app installation

description: Ability to delete an app_installation
code: app_installation:delete
implies:

  • app_installation:read

Read app installation

description: Ability to read app_installations
code: app_installation:read

Update app installation

description: Ability to update an app_installation
code: app_installation:update
implies:

  • app_installation:read

App

Create app

description: Ability to create apps
code: app:create
implies:

  • app:read

Delete app

description: Ability to delete an app
code: app:delete
implies:

  • app:read

Read app

description: Ability to read apps
code: app:read

Update app

description: Ability to update an app
code: app:update
implies:

  • app:read

Approval V 2

Update approval participants

description: Ability to update participants on an approval
code: approval_v2:participants:update
implies:

  • brief:read
  • post:read

Approval

Create approval teams

description: Ability to create approval teams
code: approval:pool:create
implies:

  • approval:pool:read

Delete approval teams

description: Ability to delete approval teams
code: approval:pool:delete
implies:

  • approval:pool:read

View approval teams

description: Ability to view approval teams
code: approval:pool:read

Update approval teams

description: Ability to update approval teams
code: approval:pool:update
implies:

  • approval:pool:read

Approve an item under approval

description: Ability to approve or leave feedback on items pending approval
code: approval:post:approve
implies:

  • approval:post:read

View an approval workflow

description: Ability to view items pending approval
code: approval:post:read

Campaign Template Tree Node

Create new integrated campaign templates

description: Ability to create integrated campaign templates
code: campaign_template_tree_node:create
implies:

  • campaign_template_tree_node:read

Delete integrated campaign templates

description: Ability to delete integrated campaign templates
code: campaign_template_tree_node:delete
implies:

  • campaign_template_tree_node:read

Edit integrated campaign templates

description: Ability to edit integrated campaign templates
code: campaign_template_tree_node:edit
implies:

  • campaign_template_tree_node:read

View integrated campaign templates

description: Ability to view integrated campaign templates
code: campaign_template_tree_node:read

Campaign Template

Create a new campaign template

description: Ability to create a campaign template
code: campaign_template:create
implies:

  • campaign_template:read

Delete campaign templates

description: Ability to delete all campaign templates
code: campaign_template:delete
implies:

  • campaign_template:read

Edit campaign templates

description: Ability to edit all campaign templates
code: campaign_template:edit
implies:

  • campaign_template:read

View campaign templates

description: Ability to view all campaign templates
code: campaign_template:read

Client

Reset client secret

description: Reset client secret
code: client:reset_secret

Comment

Delete comments within license scope

description: Able to delete other user's comments within scope
code: comment:manage

Export

Download data

description: Ability to download exportable CSV files
code: export:read

Favorite

Create a favorite

description: Ability to create a favorite
code: favorite:create
implies:

  • favorite:read

Delete a favorite

description: Ability to delete a favorite
code: favorite:delete
implies:

  • favorite:read

Read a favorite

description: Ability to read a favorite
code: favorite:read

Folders

Create folders

description: Ability to create folders in the media library
code: folders:create
implies:

  • media:read

Delete folders

description: Ability to delete folders in the media library
code: folders:delete
implies:

  • media:delete
  • media:read

Create folders metadata

description: Create folders metadata
code: folders:metadata:create
implies:

  • media:read
  • schema:read

Delete folders metadata

description: Delete folders metadata
code: folders:metadata:delete
implies:

  • media:read
  • schema:read

Read folders metadata

description: Read folders metadata
code: folders:metadata:read
implies:

  • media:read
  • schema:read

Update folders metadata

description: Update folders metadata
code: folders:metadata:update
implies:

  • media:read
  • schema:read

View folders

description: Ability to view folders in the media library
code: folders:read

Fulfillment

Create a fulfillment of a content requisition

description: Ability to create a fulfillment
code: fulfillment:create
implies:

  • fulfillment:read

Edit a fulfillment of a content requisition

description: Ability to edit a fulfillment
code: fulfillment:edit
implies:

  • fulfillment:read

View a fulfillment of a content requisition

description: Ability to view a fulfillment
code: fulfillment:read

Idp App User

Create an identity provider app user

description: Ability to create an identity provider app user
code: idp_app_user:create
implies:

  • idp_app_user:read

Delete an identity provider app user

description: Ability to delete an identity provider app user
code: idp_app_user:delete
implies:

  • idp_app_user:read

View identity provider app users

description: Ability to view identity provider app users in a tenant
code: idp_app_user:read

Update an identity provider app user

description: Ability to update an identity provider app user
code: idp_app_user:update
implies:

  • idp_app_user:read

License

Read publishing settings

description: Ability to read publishing settings
code: license:publishing:settings:read

Update publishing settings

description: Ability to update publishing settings
code: license:publishing:settings:update
implies:

  • license:publishing:settings:read

View license settings

description: View settings that are specific to a license
code: license:read

Edit license settings

description: Edit settings that are specific to a license
code: license:update

Pageproof Template

Manage a pageproof template

description: Ability to update/delete/create pageproof_templates
code: pageproof_template:manage
implies:

  • pageproof_template:read

Read pageproof template

description: Ability to read pageproof templates
code: pageproof_template:read

Partner

View partner information

description: View partner ID, name and requirements
code: partner:read

Preference

Read preference records

description: Ability to read preference records
code: preference:read

Update preference records

description: Ability to update preference records
code: preference:update
implies:

  • preference:read

Preview Format

Create preview format

description: Ability to create preview formats
code: preview_format:create
implies:

  • preview_format:read

Delete preview format

description: Ability to delete a preview format
code: preview_format:delete
implies:

  • preview_format:read

Read preview format

description: Ability to read a preview format
code: preview_format:read

Update preview format

description: Ability to update a preview format
code: preview_format:update
implies:

  • preview_format:read

Preview Template

Create preview template

description: Ability to create preview templates
code: preview_template:create
implies:

  • preview_template:read

Delete preview template

description: Ability to delete a preview template
code: preview_template:delete
implies:

  • preview_template:read

Read preview template

description: Ability to read a preview template
code: preview_template:read

Update preview template

description: Ability to update a preview template
code: preview_template:update
implies:

  • preview_template:read

Production Workflow

Create a workflow setup

description: Ability to create a workflow setup
code: production_workflow:create
implies:

  • production_workflow:read

Delete a workflow setup

description: Ability to delete a workflow setup
code: production_workflow:delete
implies:

  • production_workflow:read

Read a workflow setup

description: Ability to read a workflow setup
code: production_workflow:read

Update a workflow setup

description: Ability to update a workflow setup
code: production_workflow:update
implies:

  • production_workflow:read

Publishing

Pause publishing

description: Ability to temporarily halt the publication of all content
code: publishing:pause
implies:

  • post:read

Report Dashboard

Create an analytics report dashboard

description: Ability to create an analytics report dashboard
code: report_dashboard:create
implies:

  • analytics:read

Delete an analytics report dashboard

description: Ability to delete an analytics report dashboard
code: report_dashboard:delete
implies:

  • analytics:read

Update an analytics report dashboard

description: Ability to update an analytics report dashboard
code: report_dashboard:update
implies:

  • analytics:read

Report

Create an analytics report

description: Ability to create an analytics report
code: report:create
implies:

  • analytics:read

Delete an analytics report

description: Ability to delete an analytics report
code: report:delete
implies:

  • analytics:read

Update an analytics report

description: Ability to update an analytics report
code: report:update
implies:

  • analytics:read

Requisition

Create a new campaign requisition

description: Ability to create a campaign requisition
code: requisition:create
implies:

  • requisition:read

Delete a campaign requisition

description: Ability to delete a campaign requisition
code: requisition:delete
implies:

  • requisition:read

Edit a campaign requisition

description: Ability to edit a campaign requisition
code: requisition:edit
implies:

  • requisition:read

View content requisition

description: Ability to view a content requisitions
code: requisition:read

Role

Manage roles

description: CRUD on roles
code: role:manage
implies:

  • role:read

Read roles

description: Ability to read roles
code: role:read

Saved Search

Create saved searches

description: Ability to create saved searches
code: saved_search:create
implies:

  • media:read
  • saved_search:read

Delete saved searches

description: Ability to delete saved searches
code: saved_search:delete
implies:

  • media:read
  • saved_search:read

Edit saved searches

description: Ability to edit saved searches
code: saved_search:edit
implies:

  • media:read
  • saved_search:read

View saved searches

description: Ability to view saved searches
code: saved_search:read
implies:

  • media:read

Saved View

Create a saved view

description: Ability to create a saved view
code: saved_view:create
implies:

  • saved_view:read

Delete a saved view

description: Ability to delete a saved view
code: saved_view:delete
implies:

  • saved_view:read

Read a saved view

description: Ability to read a saved view
code: saved_view:read

Delete a team saved view

description: Ability to delete a team saved view
code: saved_view:team:delete
implies:

  • saved_view:delete

Update a team saved view

description: Ability to update a team saved view
code: saved_view:team:update
implies:

  • saved_view:update

Update a saved view

description: Ability to update a saved view
code: saved_view:update
implies:

  • saved_view:read

Schema

Manage schema

description: Ability to update/delete schemas
code: schema:manage

Read schema

description: Ability to read schemas
code: schema:read

Scope

Edit scope profile

description: Edit scope profile settings
code: scope:profile:update

Share

Create a new campaign template share

description: Ability to share a campaign template
code: share:campaign_template:create

Delete campaign template shares

description: Ability to delete all shares of campaign templates
code: share:campaign_template:delete

Manage access to percolate items

description: Ability to create a content share
code: share:create
implies:

  • share:read

Create custom channel template share

description: Create a share for a custom channel template
code: share:custom_channel_template:create

Delete custom channel template shares

description: Delete a share for a custom channel template
code: share:custom_channel_template:delete

Delete a content share

description: Ability to delete a content share
code: share:delete
implies:

  • share:create

Create an intake request template share

description: Ability to create an intake request template share
code: share:intake_request_template:create

Delete an intake request template share

description: Ability to delete an intake request template share
code: share:intake_request_template:delete

View a content share

description: Ability to view a content share
code: share:read

Share object to scope in restrictive share mode

description: Ability to share object with target scope in restrictive share mode
code: share:restrictive:create

Targeting

Create targeting

description: Ability to create targeting
code: targeting:create
implies:

  • targeting:read

Read targeting data

description: Ability to read targeting data
code: targeting:read

Update targeting

description: Ability to update targeting
code: targeting:update
implies:

  • targeting:read

Task Template

Create task templates

description: Ability to create task templates
code: task_template:create
implies:

  • task_template:read

Delete task templates

description: Ability to delete task templates
code: task_template:delete
implies:

  • task_template:read

View task templates

description: Ability to view task templates
code: task_template:read

Update task templates

description: Ability to update task templates
code: task_template:update
implies:

  • task_template:read

Term

Create a term

description: Create a term
code: term:create

Delete a term

description: Delete a term
code: term:delete

Edit a term

description: Edit a term
code: term:update

Translate

Translate text

description: Create machine translations of arbitrary blocks of text
code: translate:machine

Trashcan

View trashcan

description: Ability to view trashcan
code: trashcan:read
implies:

  • media:read

User

Create a user

description: Create a user within a scope
code: user:create
implies:

  • user:read

Remove a user

description: Remove a user from a scope
code: user:delete
implies:

  • user:read

View a user

description: View a user within a scope
code: user:read

Edit a user

description: Edit a user within a scope
code: user:update
implies:

  • user:read

View

View analytics

description: View the analytics section
code: view:analytics
implies:

  • analytics:read
  • app_installation:read
  • export:read
  • license_channel:read
  • preference:update

View approvals

description: View the approvals section
code: view:approvals
implies:

  • app_installation:read
  • preference:update

View asset manager

description: View the asset manager
code: view:asset_library
implies:

  • activity:read
  • app_installation:read
  • folders:read
  • media:read
  • preference:update

View campaigns

description: View the campaigns section
code: view:campaigns
implies:

  • activity:read
  • app_installation:read
  • brief:read
  • preference:update

View content

description: View the content section
code: view:creative
implies:

  • activity:read
  • app_installation:read
  • post:read
  • preference:update

View intake requests

description: View the intake requests section
code: view:intake_requests
implies:

  • activity:read
  • app_installation:read
  • intake_request:read
  • preference:update

View calendar

description: View the calendar
code: view:planner
implies:

  • activity:read
  • app_installation:read
  • brief:read
  • preference:update

View shares

description: View the shares section
code: view:shares
implies:

  • app_installation:read
  • preference:update

View tasks

description: View the tasks section
code: view:tasks
implies:

  • app_installation:read
  • preference:update
  • task:read

Webhook Subscription

Manage webhook subscription

description: Ability to create, read, update, delete webhook subscriptions
code: webhook_subscription:manage

Webhook

Manage webhook subscription

description: Ability to update/disable webhook subscriptions
code: webhook:manage
implies:

  • webhook:read

Read webhook subscription

description: Ability to read webhook subscriptions
code: webhook:read

Updated over 4 years ago