Skip to main content

Bynder Component

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

Component key: bynder ·
· Changelog ↓

Description​

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 Client Credentials​

key: bynder-client-credentials-oauth

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:
    • 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.
  4. Add at least the following scopes: asset:read asset:write collection:read collection:write
  5. 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
InputNotesExample
Client ID

The Client ID from the Bynder OAuth application credentials.

12345678-1234-1234-1234-123456789abc
Client Secret

The Client Secret from the Bynder OAuth application credentials.

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

The OAuth 2.0 token URL used to exchange the client credentials for an access token.

https://portal.bynder.com/v6/authentication/oauth2/token

OAuth 2.0​

key: bynder-oauth

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:
    • Set the redirect URI to https://oauth2.prismatic.io/callback
  4. Add at least the following scopes: asset:read asset:write collection:read collection:write
  5. 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
InputNotesExample
Authorize URL

The OAuth 2.0 authorization URL for the Bynder domain.

https://portal.bynder.com/v6/authentication/oauth2/auth
Client ID

The Client ID from the Bynder OAuth application credentials.

12345678-1234-1234-1234-123456789abc
Client Secret

The Client Secret from the Bynder OAuth application credentials.

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

The OAuth 2.0 token URL used to exchange the authorization code for an access token.

https://portal.bynder.com/v6/authentication/oauth2/token

Triggers​

New and Updated Records​

Checks for new and updated records in a selected Bynder resource type on a configured schedule. | key: pollChangesTrigger

InputNotesExample
Connection

The Bynder connection to use.

Resource Type

The type of resource to poll for new and updated records.

Show New Records

Include newly created records in trigger results.

true
Show Updated Records

Include updated records in trigger results.

true

This trigger polls the Bynder API for new and updated records across a selected resource type on a configured schedule.

How It Works​

  1. The trigger runs on the configured schedule (e.g., every 5 minutes)
  2. It fetches records from the selected Bynder resource type
  3. Records are categorized as created or updated based on their dateCreated and dateModified timestamp fields, compared against the last successful poll time
  4. The trigger updates its internal state after each poll, storing the poll timestamp for use in the next execution

Configuration​

Configure the following inputs:

  • Connection: The Bynder connection used to authenticate API requests

  • Resource Type: The Bynder resource to monitor. Available options:

    ResourceChange DetectionTracks NewTracks Updated
    AssetsTimestamp (dateCreated, dateModified)YesYes
    CollectionsTimestamp (dateCreated, dateModified)YesYes
    CampaignsTimestamp (dateCreated, dateModified)YesYes
    JobsTimestamp (dateCreated, dateModified)YesYes
    OrdersTimestamp (dateCreated)YesNo

  • Show New Records: When enabled, includes newly created records in the results. Defaults to true

  • Show Updated Records: When enabled, includes modified records in the results. Applies only to resource types that support update tracking (Assets, Collections, Campaigns, Jobs). Defaults to true

Returned Data​

The trigger returns an object with two arrays — created for new records and updated for modified records. For Orders, updated is always an empty array because the API does not expose an update timestamp.

Example Response
{
  "data": {
    "created": [
      {
        "id": "A1B2C3D4-E5F6-7890-ABCD-EF1234567890",
        "name": "Product Launch Banner",
        "dateCreated": "2024-01-15T10:30:00Z",
        "dateModified": "2024-01-15T10:30:00Z"
      }
    ],
    "updated": [
      {
        "id": "F9E8D7C6-B5A4-3210-FEDC-BA9876543210",
        "name": "Brand Guidelines 2024",
        "dateCreated": "2024-01-01T08:00:00Z",
        "dateModified": "2024-01-16T14:22:00Z"
      }
    ]
  }
}

Notes​

  • A record is classified as created if its dateCreated exceeds the last poll time. If dateCreated does not exceed the cutoff but dateModified does, the record is classified as updated
  • Orders lack a dateModified field in the Bynder API response, so update tracking is not available for that resource type

Data Sources​

Select Asset​

Select an asset from the list of assets available in Bynder. | key: selectAsset | type: picklist

InputNotesExample
Connection
Example Payload for Select Asset⤓
Loading…

Select Brand​

Select a brand from the list of brands available in Bynder. | key: selectBrand | type: picklist

InputNotesExample
Connection
Example Payload for Select Brand⤓
Loading…

Select Campaign​

Select a campaign from the list of campaigns available in Bynder. | key: selectCampaign | type: picklist

InputNotesExample
Connection
Example Payload for Select Campaign⤓
Loading…

Select Collection​

Select a collection from the list of collections available in Bynder. | key: selectCollection | type: picklist

InputNotesExample
Connection
Example Payload for Select Collection⤓
Loading…

Select Job​

Select a job from the list of jobs available in Bynder. | key: selectJob | type: picklist

InputNotesExample
Connection
Example Payload for Select Job⤓
Loading…

Select Metaproperty​

Select a metaproperty from the list of metaproperties available in Bynder. | key: selectMetaproperty | type: picklist

InputNotesExample
Connection
Example Payload for Select Metaproperty⤓
Loading…

Select Order​

Select an order from the list of orders available in Bynder. | key: selectOrder | type: picklist

InputNotesExample
Connection
Example Payload for Select Order⤓
Loading…

Select Security Profile​

Select a security profile from the list of profiles available in Bynder. | key: selectSecurityProfile | type: picklist

InputNotesExample
Connection
Example Payload for Select Security Profile⤓
Loading…

Select User​

Select a user from the list of users available in Bynder. | key: selectUser | type: picklist

InputNotesExample
Connection
Example Payload for Select User⤓
Loading…

Actions​

Add Asset Metaproperty Options​

Add metaproperty options to an asset | key: addAssetMetapropertyOptions

InputNotesExample
Asset ID

Id of the asset.

00000000-0000-0000-0000000000000000
Connection
Metaproperty ID

Id of the metaproperty from which you want to add options.

00000000-0000-0000-0000000000000000
Metaproperty Options IDs

List of metaproperty option ids you want to add to the asset.

00000000-0000-0000-0000000000000000
Example Payload for Add Asset Metaproperty Options⤓
Loading…

Close Campaign​

Delete an existing campaign | key: closeCampaign

InputNotesExample
Connection
Campaign ID

The ID of the campaign to delete

00000000-0000-0000-0000000000000000
Example Payload for Close Campaign⤓
Loading…

Create Campaign​

Create a new campaign | key: createCampaign

InputNotesExample
Data

Additional data to update the campaign

{
  "dateStart": "2021-01-01T00:00:00Z",
  "deadline": "2021-12-31T23:59:59Z"
}
Connection
Description

The description of the campaign

Extended asset description
Key

4 character key representing the campaign

excp
Name

The name of the campaign

Asset Name
Responsible ID

Id of the user responsible for the campaign

00000000-0000-0000-0000-000000000000
Example Payload for Create Campaign⤓
Loading…

Create Collection​

Create a new collection | key: createCollection

InputNotesExample
Connection
Collection Description

The description of the collection to create

Extended asset description
Collection Name

The name of the collection to create

Asset Name
Example Payload for Create Collection⤓
Loading…

Create Job​

Create a new job | key: createJob

InputNotesExample
Accountable ID

Id of the user responsible for the job

00000000-0000-0000-0000000000000000
Data

Additional data to create the job

{
  "deadline": "2021-12-31T23:59:59Z",
  "stages": [
    {
      "name": "Stage 1"
    },
    {
      "name": "Stage 2"
    }
  ]
}
Campaign ID

Id of the campaign the job is part of

00000000-0000-0000-0000000000000000
Connection
Description

The description of the job

Extended asset description
Name

The name of the job

Asset Name
Preset ID

Id of the preset the job should be created from

00000000-0000-0000-0000000000000000
Example Payload for Create Job⤓
Loading…

Create User​

Create a new user | key: createUser

InputNotesExample
Data

Extra fields to be included in the request. Must be valid JSON.

{
  "active": 1,
  "job": "Developer",
  "department": "Development",
  "phoneNumber": "+00 123456789"
}
Connection
Email

Email address for login.

test@test.com
First Name

First name of the user.

John
Last Name

Last name of the user.

Doe
Password

Password for login.

password
Profile ID

Security profile id for determining the user's rights. Can be retrieved by using the Retrieve security profiles call.

00000000-0000-0000-0000000000000000
Username

Username for login. If not defined it will take your email as username.

user123
Example Payload for Create User⤓
Loading…

Delete Asset​

Delete an existing asset | key: deleteAsset

InputNotesExample
Connection
ID

The ID of the resource to retrieve

00000000-0000-0000-0000000000000000
Example Payload for Delete Asset⤓
Loading…

Delete Asset Metaproperty Options​

Remove metaproperty options from an asset | key: deleteAssetMetapropertyOptions

InputNotesExample
Asset ID

Id of the asset.

00000000-0000-0000-0000000000000000
Connection
Metaproperty ID

Id of the metaproperty from which you want to add options.

00000000-0000-0000-0000000000000000
Metaproperty Options IDs

List of metaproperty option ids you want to add to the asset.

00000000-0000-0000-0000000000000000
Example Payload for Delete Asset Metaproperty Options⤓
Loading…

Delete Campaign​

Delete an existing campaign | key: deleteCampaign

InputNotesExample
Connection
Campaign ID

The ID of the campaign to delete

00000000-0000-0000-0000000000000000
Example Payload for Delete Campaign⤓
Loading…

Delete Collection​

Delete an existing collection | key: deleteCollection

InputNotesExample
Connection
Collection ID

The ID of the collection to delete

00000000-0000-0000-0000000000000000
Example Payload for Delete Collection⤓
Loading…

Delete Job​

Delete an existing job | key: deleteJob

InputNotesExample
Connection
Job ID

The ID of the job to delete

00000000-0000-0000-0000000000000000
Example Payload for Delete Job⤓
Loading…

Delete User​

Remove an existing user | key: deleteUser

InputNotesExample
Connection
ID

The ID of the resource to retrieve

00000000-0000-0000-0000000000000000

Download Specific Asset Item​

Download an specific asset item | key: downloadSpecificAssetItem

InputNotesExample
Connection
Hash

Indicates whether or not to treat the itemId as a hashed item id

false
Asset ID

The id of the asset you’d like to download a item of.

00000000-0000-0000-0000000000000000
Item ID

The id of the specific asset item you’d like to download.

00000000-0000-0000-0000000000000000
Example Payload for Download Specific Asset Item⤓
Loading…

Finalize Complete Upload​

Finalize a completely uploaded file. | key: finaliseCompleteUpload

InputNotesExample
Chunks

Total number of chunks uploaded.

Connection
ID

ID of the upload.

T3.fS5.5HPhtYFtm2b_.e7wVe910tL5XQutKw1jkMqlP5cPQVyZkOZxZ9lJiGUk4FIw6M0CFZ3xogTWrm.GPI2p2CaglQcAS5aH37zT_vHJnbtkebYbheXIQc_.M_6hM
Original Filename

Filename including special characters to be displayed in Bynder.

Logo.png
S3 Filename

Base location of the uploaded file.

api_uploads/159D8D4B-B981-49B8-BF0569FD144CB359/A29FABF0-26B8-44BF-890920E4C09E7C11/Logo.png
Target ID

The targetid that was returned by the initialize call.

final/00000000-0000-0000-0000000000000000/Logo.png
Example Payload for Finalize Complete Upload⤓
Loading…

Finalize Complete Upload And Save As New Asset Additional​

Finalize a completely uploaded file and save as a new asset additional. | key: finaliseCompleteUploadAndSaveAsNewAsset

InputNotesExample
Asset ID

Asset id to which to save the new additional.

00000000-0000-0000-0000000000000000
Chunks

Total number of chunks uploaded.

Connection
S3 Filename

Base location of the uploaded file or filename result from the last upload chunk action.

api_uploads/159D8D4B-B981-49B8-BF0569FD144CB359/A29FABF0-26B8-44BF-890920E4C09E7C11/Logo.png/p{chunks}
Target ID

The targetid that was returned by the initialize call.

final/00000000-0000-0000-0000000000000000/Logo.png
ID

ID of the upload.

T3.fS5.5HPhtYFtm2b_.e7wVe910tL5XQutKw1jkMqlP5cPQVyZkOZxZ9lJiGUk4FIw6M0CFZ3xogTWrm.GPI2p2CaglQcAS5aH37zT_vHJnbtkebYbheXIQc_.M_6hM
Example Payload for Finalize Complete Upload And Save As New Asset Additional⤓
Loading…

Generate Dynamic Asset Transformation​

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

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

0.5,0.25
Format

Format of the served image. This can either be jpg or png and it will overwrite the default webP.

jpg
ID

The ID of the resource to retrieve

00000000-0000-0000-0000000000000000
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.

transform:crop,width:100,height:200
Name

Name of the asset, beware the asset will have no name when this is empty.

Asset Name
Format

Image quality, ranging from 1 - 100 (has no effect when format is set to 'png').

75
Example Payload for Generate Dynamic Asset Transformation⤓
Loading…

Get Account Information​

Retrieve information on current account | key: getAccountInformation

InputNotesExample
Connection
Example Payload for Get Account Information⤓
Loading…

Get Asset​

Retrieve a specific asset | key: getAsset

InputNotesExample
Connection
ID

The ID of the resource to retrieve

00000000-0000-0000-0000000000000000
Stats

Include information about views and downloads.

false
Versions

Include information about the different asset media items including versions.

false
Example Payload for Get Asset⤓
Loading…

Get Campaign​

Retrieve a specific campaign | key: getCampaign

InputNotesExample
Connection
Campaign ID

The ID of the campaign to retrieve

00000000-0000-0000-0000000000000000
Example Payload for Get Campaign⤓
Loading…

Get Closest S3 Upload Endpoint​

Retrieve the closest S3 upload endpoint | key: getClosestS3Endpoint

InputNotesExample
Connection
Example Payload for Get Closest S3 Upload Endpoint⤓
Loading…

Get Collection​

Retrieve a specific collection | key: getCollection

InputNotesExample
Connection
Collection ID

The ID of the collection to retrieve

00000000-0000-0000-0000000000000000
Example Payload for Get Collection⤓
Loading…

Get Current User​

Retrieve the current user | key: getCurrentUser

InputNotesExample
Connection
Example Payload for Get Current User⤓
Loading…

Get Job​

Retrieve a job by ID | key: getJob

InputNotesExample
Connection
Job ID

The ID of the job to retrieve

00000000-0000-0000-0000000000000000
Example Payload for Get Job⤓
Loading…

Get Job Preset​

Retrieve a job preset by ID | key: getJobPreset

InputNotesExample
Connection
Job preset ID

The ID of the job preset to retrieve

00000000-0000-0000-0000000000000000
Example Payload for Get Job Preset⤓
Loading…

Get Media of Job​

Retrieve media attached to an existing job | key: getMediaOfJob

InputNotesExample
Connection
Job ID

The ID of the job to retrieve

00000000-0000-0000-0000000000000000
Example Payload for Get Media of Job⤓
Loading…

Get Order​

Retrieve an existing order | key: getOrder

InputNotesExample
Connection
Order ID

The ID of the order to retrieve. Either id or orderNumber is required

00000000-0000-0000-0000000000000000
Order Number

The order number of the order to retrieve. Either id or orderNumber is required

00000000-0000-0000-0000000000000000
Example Payload for Get Order⤓
Loading…

Get Order Info​

Retrieve information on an order | key: getOrderInfo

InputNotesExample
Connection
Order ID

The ID of the order to retrieve

00000000-0000-0000-0000000000000000
Example Payload for Get Order Info⤓
Loading…

Get Security Profile​

Retrieve a specified security profile | key: getSecurityProfile

InputNotesExample
Connection
Security Profile ID

The ID of the security profile to retrieve.

00000000-0000-0000-0000000000000000
Example Payload for Get Security Profile⤓
Loading…

Get User​

Retrieve a specified user | key: getUser

InputNotesExample
Connection
ID

The ID or username of the user to retrieve

00000000-0000-0000-0000000000000000
Example Payload for Get User⤓
Loading…

Initialize Upload​

Initialize a new file upload. | key: initialiseUpload

InputNotesExample
Connection
Filename

Filename of new upload (extension required).

image.jpeg
Example Payload for Initialize Upload⤓
Loading…

List Assets​

Retrieve all assets | key: listAssets

InputNotesExample
Connection
Count

Indicating whether or not the response should include count results. This parameter when passed as true overrides the total parameter.

false
Extra Parameters

Extra parameters to be included in the request.

Fetch All

Whether to fetch all results. If true, limit and page parameters are ignored.

true
Limit

Maximum number of results. Maximum: 1000. Default: 50

100
Page

The page number to retrieve

1
Total

Indicating whether or not the response should include the total count of results.

false
Example Payload for List Assets⤓
Loading…

List Brands​

Retrieve all brands | key: listBrands

InputNotesExample
Connection
Example Payload for List Brands⤓
Loading…

List Campaigns​

Retrieve all campaigns | key: listCampaigns

InputNotesExample
Connection
Example Payload for List Campaigns⤓
Loading…

List Collections​

Retrieve all collections | key: listCollections

InputNotesExample
Connection
Count

Indicating whether or not the response should include count results. This parameter when passed as true overrides the total parameter.

false
Extra Parameters

Extra parameters to be included in the request.

Fetch All

Whether to fetch all results. If true, limit and page parameters are ignored.

true
Limit

Maximum results to return. If limit is not provided, all results are returned.

100
Page

The page number to retrieve

1
Example Payload for List Collections⤓
Loading…

List Jobs​

Retrieve all jobs | key: listJobs

InputNotesExample
Connection
Extra Parameters

Extra parameters to be included in the request.

Limit

Maximum results to return. If limit is not provided, all results are returned.

100
Page

The page number to retrieve

1
Example Payload for List Jobs⤓
Loading…

List Jobs By Campaign​

Retrieve jobs tied to a campaign | key: listJobsByCampaign

InputNotesExample
Connection
Extra Parameters

Extra parameters to be included in the request.

Campaign ID

The ID of the campaign to retrieve jobs for

00000000-0000-0000-0000000000000000
Limit

Maximum results to return. If limit is not provided, all results are returned.

100
Page

The page number to retrieve

1
Example Payload for List Jobs By Campaign⤓
Loading…

List Metaproperties​

Retrieve all metaproperties. | key: listMetaproperties

InputNotesExample
Connection
Count

Indicates whether or not the response should include asset count results for metaproperty-options.

false
IDs

List of metaproperty ids. Will return a metaproperty for each existing id.

Format

Indicates whether or not the response should include the metaproperty options of each metaproperty.

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.

Example Payload for List Metaproperties⤓
Loading…

List Orders​

Retrieve all orders. | key: listOrders

InputNotesExample
Connection
Page

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

1
Example Payload for List Orders⤓
Loading…

List Security Profiles​

Retrieve all security profiles | key: listSecurityProfiles

InputNotesExample
Connection
Example Payload for List Security Profiles⤓
Loading…

List Users​

Retrieve all users | key: listUsers

InputNotesExample
Connection
Include Inactive

Whether to include inactive users in the list of results.

false
Limit

Maximum results to return. If limit is not provided, all results are returned.

100
Page

The page number to retrieve

1
Example Payload for List Users⤓
Loading…

Raw Request​

Send raw HTTP request to Bynder | key: rawRequest

InputNotesExample
Connection
Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

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.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
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
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

This is the URL to call.

Input the path only (/v4/media/), The base URL is already included (https://your-bynder-domain/api/). For example, to connect to https://your-bynder-domain/api/v4/media/, only /v4/media/ is entered in this field. e.g. /v4/media/
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​

Register an uploaded chunk. | key: registerUploadedChunk

InputNotesExample
Chunk Number

Number of the chunk that was uploaded.

Connection
Filename

Location of the uploaded chunk.

api_uploads/00000000-0000-0000-0000000000000000/00000000-0000-0000-0000000000000000/Logo.png/p5
ID

ID of the upload.

T3.fS5.5HPhtYFtm2b_.e7wVe910tL5XQutKw1jkMqlP5cPQVyZkOZxZ9lJiGUk4FIw6M0CFZ3xogTWrm.GPI2p2CaglQcAS5aH37zT_vHJnbtkebYbheXIQc_.M_6hM
Target ID

The targetid that was returned by the initialize call.

final/00000000-0000-0000-0000000000000000/Logo.png
Example Payload for Register Uploaded Chunk⤓
Loading…

Retrieve Poll State​

Poll processing state of finalized files | key: retrievePollState

InputNotesExample
Connection
Items

Comma-separated import id's of a finalized file, as returned by the finalize call.

000000000-0000-0000-0000000000000000
Example Payload for Retrieve Poll State⤓
Loading…

Save a New Asset​

Save a completed upload as a new asset. | key: saveAsNewAsset

InputNotesExample
Data

Data of the new asset.

{
  "isPublic": true,
  "audit": false,
  "publicationDate": "05-31-2010",
  "tags": "scenery,grassland,Holland",
  "watermarkDate": "2014-12-25T10:30:00Z"
}
Brand ID

Brand id to save the asset to.

00000000-0000-0000-0000000000000000
Connection
Copyright

Copyright information of the asset.

Copyright (c) Example corp
Description

Asset description.

Extended asset description
Import ID

Import id of a finalized and processed upload to be saved.

00000000-0000-0000-0000000000000000
Asset Name

Name of the new asset.

Logo
Example Payload for Save a New Asset⤓
Loading…

Save as a New Asset Version​

Save a completed upload as a new asset version. | key: saveAsNewAssetVersion

InputNotesExample
Asset ID

Asset id for which to save the new version.

00000000-0000-0000-0000000000000000
Connection
Import ID

Import id of a finalized and processed upload to be saved.

00000000-0000-0000-0000000000000000
Example Payload for Save as a New Asset Version⤓
Loading…

Share Collection​

Share a collection | key: shareCollection

InputNotesExample
Data

Extra fields to be included in the request. Must be valid JSON.

{
  "sendMail": true,
  "message": "Any message"
}
Collection Options

Recipient rights.

Connection
Groups

Comma-separated list of group ids. Mandatory if recipients or profiles are empty.

000000000-0000-0000-0000000000000000
Collection ID

The ID of the collection to retrieve

00000000-0000-0000-0000000000000000
Profiles

Comma-separated list of profile ids. Mandatory if recipients or groups are empty.

000000000-0000-0000-0000000000000000
Recipients

Comma-separated email addresses of recipients. Mandatory if groups or profiles are empty.

user1@bynder.com,user2@bynder.com
Example Payload for Share Collection⤓
Loading…

Update Asset​

Edit an existing asset | key: updateAsset

InputNotesExample
Data

Extra fields to be included in the request. Must be valid JSON.

{
  "isPublic": true,
  "limited": true,
  "archive": true,
  "tags": "scenery,grassland,Holland"
}
Connection
Copyright

Copyright information of the asset.

Copyright (c) Example corp
Description

Asset description.

Extended asset description
ID

The ID of the resource to retrieve

00000000-0000-0000-0000000000000000
Name

Name of the asset, beware the asset will have no name when this is empty.

Asset Name
Example Payload for Update Asset⤓
Loading…

Update Campaign​

Edit an existing campaign | key: updateCampaign

InputNotesExample
Data

Additional data to update the campaign

{
  "dateStart": "2021-01-01T00:00:00Z",
  "deadline": "2021-12-31T23:59:59Z"
}
Connection
Description

The description of the campaign

Extended asset description
Campaign ID

The ID of the campaign to update

00000000-0000-0000-0000000000000000
Key

4 character key representing the campaign

excp
Name

The name of the campaign

Asset Name
Responsible ID

Id of the user responsible for the campaign

00000000-0000-0000-0000-000000000000
Example Payload for Update Campaign⤓
Loading…

Update Collection​

Edit an existing collection | key: updateCollection

InputNotesExample
Connection
Collection Description

The description of the collection to create

Extended asset description
Collection ID

The ID of the collection to update

00000000-0000-0000-0000000000000000
Is Public

Indicates whether or not to treat the itemId as a hashed item id

true
Collection Name

The name of the collection to create

Asset Name
Example Payload for Update Collection⤓
Loading…

Update Job​

Edit an existing job | key: updateJob

InputNotesExample
Accountable ID

Id of the user responsible for the job

00000000-0000-0000-0000000000000000
Data

Additional data to update the job

{
  "deadline": "2021-12-31T23:59:59Z"
}
Campaign ID

Id of the campaign the job is part of

00000000-0000-0000-0000000000000000
Connection
Description

The description of the job

Extended asset description
Job ID

The ID of the job to update

00000000-0000-0000-0000000000000000
Name

The name of the job

Asset Name
Example Payload for Update Job⤓
Loading…

Update Order​

Update an existing order | key: updateOrder

InputNotesExample
Connection
Order ID

The ID of the order to update

00000000-0000-0000-0000000000000000
Message

A message

Order has been delivered
Order Status

Status of the order

Tracking Number

Link to trackingnumber

trackingnumber
Example Payload for Update Order⤓
Loading…

Update User​

Edit an existing user | key: updateUser

InputNotesExample
Data

Extra fields to be included in the request. Must be valid JSON.

{
  "active": 1,
  "job": "Developer",
  "department": "Development",
  "phoneNumber": "+00 123456789"
}
Connection
Email

Email address for login.

test@test.com
First Name

First name of the user.

John
ID

The ID of the user to update

00000000-0000-0000-0000000000000000
Last Name

Last name of the user.

Doe
Password

Password for login.

password
Profile ID

Security profile id for determining the user's rights. Can be retrieved by using the Retrieve security profiles call.

00000000-0000-0000-0000000000000000
Username

Username for login. If not defined it will take your email as username.

user123
Example Payload for Update User⤓
Loading…

Upload Chunk​

Upload a chunk of a file. | key: uploadChunk

InputNotesExample
Chunk

Chunk index number (indexing starts from 1).

Chunks

Total number of chunks.

File

File or chunk of the file to be uploaded.

Multipart Parameters

Parameters for the multipart upload. Use all the fields from the response of the initialise upload call.

{
  "acl": "private",
  "success_action_status": "201",
  "Content-Type": "image/*",
  "key": "pluploads/api/00000000-0000-0000-0000-000000000000/image.jpeg",
  "Policy": "AWS_S3_POLICY",
  "X-Amz-Signature": "AWS_S3_SIGNATURE",
  "x-amz-credential": "AWS_S3_AUTH",
  "x-amz-algorithm": "AWS4-HMAC-SHA256",
  "x-amz-date": "20160216T100755Z"
}
Upload URL

Amazon upload endpoint received from calling Get closest AmazonS3 upload endpoint.

https://bynder-public-eu-central-1.s3.amazonaws.com/
Example Payload for Upload Chunk⤓
Loading…

Changelog​

2026-04-30​

Updated spectral version

2026-04-21​

Added New and Updated Records polling trigger that checks for new and updated assets, collections, campaigns, jobs, and orders in Bynder on a configured schedule

2026-03-31​

Various modernizations and documentation updates

2026-03-05​

Added inline data sources for assets, brands, orders, users, security profiles, and metaproperties to enhance data selection capabilities