Bynder

Bynder is a leading digital asset management software that allows users to easily create, find, and use content, such as documents, graphics, and videos.

Use the Bynder component to manage Assets, Collections, Campaigns, and more.

API Documentation

The Bynder component is built using the Bynder April 2024 REST API

Connections

OAuth 2.0 {#bynder-oauth}

OAuth 2.0

To create a new OAuth App for the OAuth 2.0 Authorization Code flow:

Prerequisites

• A Bynder account with administrator access to Portal Settings

Setup Steps

1. Sign into Bynder and navigate to Settings > Advanced Settings > Portal Settings and select OAuth Apps
2. Select Register new application to create an OAuth App
3. Set Grant Type to Authorization Code and configure the redirect URL:
4. Set the redirect URI to https://oauth2.arenasolutions.com/callback
5. Add at least the following scopes: asset:read asset:write collection:read collection:write
6. Select Register application to retrieve a Client ID and Client Secret

Configure the Connection

Create a connection of type OAuth 2.0 and enter:

• Authorize URL: The Bynder authorization URL (e.g., https://{your-bynder-domain}/v6/authentication/oauth2/auth)
• Token URL: The Bynder token URL (e.g., https://{your-bynder-domain}/v6/authentication/oauth2/token)
• Scopes: The required OAuth scopes (defaults are pre-populated)
• Client ID: The Client ID from the registered OAuth application
• Client Secret: The Client Secret from the registered OAuth application

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

Input	Comments	Default
Authorize URL	The OAuth 2.0 authorization URL for the Bynder domain.
Token URL	The OAuth 2.0 token URL used to exchange the authorization code for an access token.
Scopes	Space-separated list of OAuth permission scopes granted to the access token.	asset:read asset:write collection:read collection:write current.user:read current.profile:read workflow.campaign:read workflow.campaign:write workflow.job:read workflow.job:write brandstore.order:read brandstore.order:write meta.assetbank:read meta.assetbank:write admin.profile:read admin.user:read admin.user:write workflow.preset:read offline
Client ID	The Client ID from the Bynder OAuth application credentials.
Client Secret	The Client Secret from the Bynder OAuth application credentials.

OAuth 2.0 Client Credentials {#bynder-client-credentials-oauth}

Client Credentials OAuth 2.0

To create a new OAuth App for the Client Credentials flow:

Prerequisites

• A Bynder account with administrator access to Portal Settings

Setup Steps

1. Sign into Bynder and navigate to Settings > Advanced Settings > Portal Settings and select OAuth Apps
2. Select Register new application to create an OAuth App
3. Set Grant Type to Client Credentials and configure the assigned user:
4. Choose the user for which tokens will be issued. Enter the name of the user and click one of the returned search results. A dedicated user in the portal is recommended if one does not already exist.
5. Add at least the following scopes: asset:read asset:write collection:read collection:write
6. Select Register application to retrieve a Client ID and Client Secret

Configure the Connection

Create a connection of type OAuth 2.0 Client Credentials and enter:

• Token URL: The Bynder token URL (e.g., https://{your-bynder-domain}/v6/authentication/oauth2/token)
• Scopes: The required OAuth scopes (defaults are pre-populated)
• Client ID: The Client ID from the registered OAuth application
• Client Secret: The Client Secret from the registered OAuth application

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

Input	Comments	Default
Token URL	The OAuth 2.0 token URL used to exchange the client credentials for an access token.
Scopes	Space-separated list of OAuth permission scopes granted to the access token.	asset:read asset:write collection:read collection:write current.user:read current.profile:read workflow.campaign:read workflow.campaign:write workflow.job:read workflow.job:write brandstore.order:read brandstore.order:write meta.assetbank:read meta.assetbank:write admin.profile:read admin.user:read admin.user:write workflow.preset:read offline
Client ID	The Client ID from the Bynder OAuth application credentials.
Client Secret	The Client Secret from the Bynder OAuth application credentials.

Actions

Add Asset Metaproperty Options {#addassetmetapropertyoptions}

Add metaproperty options to an asset

Input	Comments	Default
Asset ID	Id of the asset.
Metaproperty ID	Id of the metaproperty from which you want to add options.
Metaproperty Options IDs	List of metaproperty option ids you want to add to the asset.
Connection

Close Campaign {#closecampaign}

Delete an existing campaign

Input	Comments	Default
Campaign ID	The ID of the campaign to delete
Connection

Create Campaign {#createcampaign}

Create a new campaign

Input	Comments	Default
Name	The name of the campaign
Key	4 character key representing the campaign
Description	The description of the campaign
Responsible ID	Id of the user responsible for the campaign
Data	Additional data to update the campaign
Connection

Create Collection {#createcollection}

Create a new collection

Input	Comments	Default
Collection Name	The name of the collection to create
Collection Description	The description of the collection to create
Connection

Create Job {#createjob}

Create a new job

Input	Comments	Default
Name	The name of the job
Campaign ID	Id of the campaign the job is part of
Accountable ID	Id of the user responsible for the job
Preset ID	Id of the preset the job should be created from
Description	The description of the job
Data	Additional data to create the job
Connection

Create User {#createuser}

Create a new user

Input	Comments	Default
Email	Email address for login.
Password	Password for login.
Profile ID	Security profile id for determining the user's rights. Can be retrieved by using the Retrieve security profiles call.
First Name	First name of the user.
Last Name	Last name of the user.
Username	Username for login. If not defined it will take your email as username.
Data	Extra fields to be included in the request. Must be valid JSON.
Connection

Delete Asset {#deleteasset}

Delete an existing asset

Input	Comments	Default
ID	The ID of the resource to retrieve
Connection

Delete Asset Metaproperty Options {#deleteassetmetapropertyoptions}

Remove metaproperty options from an asset

Input	Comments	Default
Asset ID	Id of the asset.
Metaproperty ID	Id of the metaproperty from which you want to add options.
Metaproperty Options IDs	List of metaproperty option ids you want to add to the asset.
Connection

Delete Campaign {#deletecampaign}

Delete an existing campaign

Input	Comments	Default
Campaign ID	The ID of the campaign to delete
Connection

Delete Collection {#deletecollection}

Delete an existing collection

Input	Comments	Default
Collection ID	The ID of the collection to delete
Connection

Delete Job {#deletejob}

Delete an existing job

Input	Comments	Default
Job ID	The ID of the job to delete
Connection

Delete User {#deleteuser}

Remove an existing user

Input	Comments	Default
ID	The ID of the resource to retrieve
Connection

Download Specific Asset Item {#downloadspecificassetitem}

Download an specific asset item

Input	Comments	Default
Asset ID	The id of the asset you’d like to download a item of.
Item ID	The id of the specific asset item you’d like to download.
Hash	Indicates whether or not to treat the itemId as a hashed item id	false
Connection

Finalize Complete Upload {#finalisecompleteupload}

Finalize a completely uploaded file.

Input	Comments	Default
ID	ID of the upload.
Target ID	The targetid that was returned by the initialize call.
S3 Filename	Base location of the uploaded file.
Chunks	Total number of chunks uploaded.
Original Filename	Filename including special characters to be displayed in Bynder.
Connection

Finalize Complete Upload And Save As New Asset Additional {#finalisecompleteuploadandsaveasnewasset}

Finalize a completely uploaded file and save as a new asset additional.

Input	Comments	Default
Asset ID	Asset id to which to save the new additional.
ID	ID of the upload.
Target ID	The targetid that was returned by the initialize call.
S3 Filename	Base location of the uploaded file or filename result from the last upload chunk action.
Chunks	Total number of chunks uploaded.
Connection

Generate Dynamic Asset Transformation {#generatedynamictransformation}

Generate a derivative on the fly with a transformation (such as cropping, scaling, filling) applied to it

Input	Comments	Default
ID	The ID of the resource to retrieve
Name	Name of the asset, beware the asset will have no name when this is empty.
IO	The operation(s) performed on the image before it's served to the client. It's possible to specify this parameter several times to have several operations applied.
Focus Point	Focus point as a x,y coordinate (with values between 0 - 1). This will serve as the center point for the image operations.
Format	Format of the served image. This can either be jpg or png and it will overwrite the default webP.
Format	Image quality, ranging from 1 - 100 (has no effect when format is set to 'png').
Connection

Get Account Information {#getaccountinformation}

Retrieve information on current account

Input	Comments	Default
Connection

Get Asset {#getasset}

Retrieve a specific asset

Input	Comments	Default
ID	The ID of the resource to retrieve
Versions	Include information about the different asset media items including versions.	false
Stats	Include information about views and downloads.	false
Connection

Get Campaign {#getcampaign}

Retrieve a specific campaign

Input	Comments	Default
Campaign ID	The ID of the campaign to retrieve
Connection

Get Closest S3 Upload Endpoint {#getclosests3endpoint}

Retrieve the closest S3 upload endpoint

Input	Comments	Default
Connection

Get Collection {#getcollection}

Retrieve a specific collection

Input	Comments	Default
Collection ID	The ID of the collection to retrieve
Connection

Get Current User {#getcurrentuser}

Retrieve the current user

Input	Comments	Default
Connection

Get Job {#getjob}

Retrieve a job by ID

Input	Comments	Default
Job ID	The ID of the job to retrieve
Connection

Get Job Preset {#getjobpreset}

Retrieve a job preset by ID

Input	Comments	Default
Job preset ID	The ID of the job preset to retrieve
Connection

Get Media of Job {#getmediaofjob}

Retrieve media attached to an existing job

Input	Comments	Default
Job ID	The ID of the job to retrieve
Connection

Get Order {#getorder}

Retrieve an existing order

Input	Comments	Default
Order ID	The ID of the order to retrieve. Either id or orderNumber is required
Order Number	The order number of the order to retrieve. Either id or orderNumber is required
Connection

Get Order Info {#getorderinfo}

Retrieve information on an order

Input	Comments	Default
Order ID	The ID of the order to retrieve
Connection

Get Security Profile {#getsecurityprofile}

Retrieve a specified security profile

Input	Comments	Default
Security Profile ID	The ID of the security profile to retrieve.
Connection

Get User {#getuser}

Retrieve a specified user

Input	Comments	Default
ID	The ID or username of the user to retrieve
Connection

Initialize Upload {#initialiseupload}

Initialize a new file upload.

Input	Comments	Default
Filename	Filename of new upload (extension required).
Connection

List Assets {#listassets}

Retrieve all assets

Input	Comments	Default
Page	The page number to retrieve
Limit	Maximum number of results. Maximum: 1000. Default: 50
Count	Indicating whether or not the response should include count results. This parameter when passed as true overrides the total parameter.	false
Total	Indicating whether or not the response should include the total count of results.	false
Fetch All	Whether to fetch all results. If true, limit and page parameters are ignored.	true
Extra Parameters	Extra parameters to be included in the request.
Connection

List Brands {#listbrands}

Retrieve all brands

Input	Comments	Default
Connection

List Campaigns {#listcampaigns}

Retrieve all campaigns

Input	Comments	Default
Connection

List Collections {#listcollections}

Retrieve all collections

Input	Comments	Default
Page	The page number to retrieve
Limit	Maximum results to return. If limit is not provided, all results are returned.
Count	Indicating whether or not the response should include count results. This parameter when passed as true overrides the total parameter.	false
Fetch All	Whether to fetch all results. If true, limit and page parameters are ignored.	true
Extra Parameters	Extra parameters to be included in the request.
Connection

List Jobs {#listjobs}

Retrieve all jobs

Input	Comments	Default
Page	The page number to retrieve
Limit	Maximum results to return. If limit is not provided, all results are returned.
Extra Parameters	Extra parameters to be included in the request.
Connection

List Jobs By Campaign {#listjobsbycampaign}

Retrieve jobs tied to a campaign

Input	Comments	Default
Campaign ID	The ID of the campaign to retrieve jobs for
Page	The page number to retrieve
Limit	Maximum results to return. If limit is not provided, all results are returned.
Extra Parameters	Extra parameters to be included in the request.
Connection

List Metaproperties {#listmetaproperties}

Retrieve all metaproperties.

Input	Comments	Default
Count	Indicates whether or not the response should include asset count results for metaproperty-options.	false
Type	List of asset types. Filters the count results by asset type. It only makes sense to be defined if the count parameter was set to true.
Format	Indicates whether or not the response should include the metaproperty options of each metaproperty.	false
IDs	List of metaproperty ids. Will return a metaproperty for each existing id.
Connection

List Orders {#listorders}

Retrieve all orders.

Input	Comments	Default
Page	Offset page for results: return the N-th set of limit-results. Limit is currently hardcoded to 10.
Connection

List Security Profiles {#listsecurityprofiles}

Retrieve all security profiles

Input	Comments	Default
Connection

List Users {#listusers}

Retrieve all users

Input	Comments	Default
Page	The page number to retrieve
Limit	Maximum results to return. If limit is not provided, all results are returned.
Include Inactive	Whether to include inactive users in the list of results.	false
Connection

Raw Request {#rawrequest}

Send raw HTTP request to Bynder

Input	Comments	Default
Connection
URL	This is the URL to call.
Method	The HTTP method to use.
Data	The HTTP body payload to send to the URL.
Form Data	The Form Data to be sent as a multipart form upload.
File Data	File Data to be sent as a multipart form upload.
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Header	A list of headers to send with the request.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Timeout	The maximum time that a client will await a response to its request
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

Register Uploaded Chunk {#registeruploadedchunk}

Register an uploaded chunk.

Input	Comments	Default
ID	ID of the upload.
Chunk Number	Number of the chunk that was uploaded.
Target ID	The targetid that was returned by the initialize call.
Filename	Location of the uploaded chunk.
Connection

Retrieve Poll State {#retrievepollstate}

Poll processing state of finalized files

Input	Comments	Default
Items	Comma-separated import id's of a finalized file, as returned by the finalize call.
Connection

Save a New Asset {#saveasnewasset}

Save a completed upload as a new asset.

Input	Comments	Default
Import ID	Import id of a finalized and processed upload to be saved.
Brand ID	Brand id to save the asset to.
Asset Name	Name of the new asset.
Description	Asset description.
Copyright	Copyright information of the asset.
Data	Data of the new asset.
Connection

Save as a New Asset Version {#saveasnewassetversion}

Save a completed upload as a new asset version.

Input	Comments	Default
Asset ID	Asset id for which to save the new version.
Import ID	Import id of a finalized and processed upload to be saved.
Connection

Share Collection {#sharecollection}

Share a collection

Input	Comments	Default
Collection ID	The ID of the collection to retrieve
Collection Options	Recipient rights.
Recipients	Comma-separated email addresses of recipients. Mandatory if groups or profiles are empty.
Groups	Comma-separated list of group ids. Mandatory if recipients or profiles are empty.
Profiles	Comma-separated list of profile ids. Mandatory if recipients or groups are empty.
Data	Extra fields to be included in the request. Must be valid JSON.
Connection

Update Asset {#updateasset}

Edit an existing asset

Input	Comments	Default
ID	The ID of the resource to retrieve
Name	Name of the asset, beware the asset will have no name when this is empty.
Description	Asset description.
Copyright	Copyright information of the asset.
Data	Extra fields to be included in the request. Must be valid JSON.
Connection

Update Campaign {#updatecampaign}

Edit an existing campaign

Input	Comments	Default
Campaign ID	The ID of the campaign to update
Name	The name of the campaign
Key	4 character key representing the campaign
Responsible ID	Id of the user responsible for the campaign
Description	The description of the campaign
Data	Additional data to update the campaign
Connection

Update Collection {#updatecollection}

Edit an existing collection

Input	Comments	Default
Collection ID	The ID of the collection to update
Collection Name	The name of the collection to create
Collection Description	The description of the collection to create
Is Public	Indicates whether or not to treat the itemId as a hashed item id	true
Connection

Update Job {#updatejob}

Edit an existing job

Input	Comments	Default
Job ID	The ID of the job to update
Name	The name of the job
Campaign ID	Id of the campaign the job is part of
Accountable ID	Id of the user responsible for the job
Description	The description of the job
Data	Additional data to update the job
Connection

Update Order {#updateorder}

Update an existing order

Input	Comments	Default
Order ID	The ID of the order to update
Order Status	Status of the order
Message	A message
Tracking Number	Link to trackingnumber
Connection

Update User {#updateuser}

Edit an existing user

Input	Comments	Default
ID	The ID of the user to update
Email	Email address for login.
Password	Password for login.
Profile ID	Security profile id for determining the user's rights. Can be retrieved by using the Retrieve security profiles call.
First Name	First name of the user.
Last Name	Last name of the user.
Username	Username for login. If not defined it will take your email as username.
Data	Extra fields to be included in the request. Must be valid JSON.
Connection

Upload Chunk {#uploadchunk}

Upload a chunk of a file.

Input	Comments	Default
Upload URL	Amazon upload endpoint received from calling Get closest AmazonS3 upload endpoint.
File	File or chunk of the file to be uploaded.
Chunk	Chunk index number (indexing starts from 1).
Chunks	Total number of chunks.
Multipart Parameters	Parameters for the multipart upload. Use all the fields from the response of the initialise upload call.