Brandfolderconnector v1.0

Version 1.0

Connector Overview: This page documents all 61 actions for the Brandfolderconnector v1.0.

Assets (8)

POST Create Custom Fields for an Asset

/custom_field_keys/{custom_field_key_id}/custom_field_values

Create custom field values for a specific custom field key on an asset. Use this to set or add custom metadata values tied to a particular custom field key.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Custom Field Key Id

The unique identifier of the custom field key to which the new custom field value belongs.

Response Type

The response format expected from the API (e.g. application/json).

POST Create Tags for an Asset

/assets/{asset_id}/tags

Add new tags to an asset. Use this to attach tags that help organize and categorize assets.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Asset Id

The unique identifier of the asset to which tags will be added.

Response Type

The response format expected from the API (e.g. application/json).

DELETE Delete an Asset

/assets/{asset_id}

Permanently delete an asset. Use this to remove an asset from the system entirely.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Asset Id

The unique identifier of the asset to delete.

Response Type

The response format expected from the API (e.g. application/json).

GET Fetch an Asset

/assets/{asset_id}

Retrieve details of a specific asset. Use this to get asset metadata and related data.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Fields

A comma-separated list of field names to include in the response, limiting the returned attributes.

Include

A comma-separated list of related resources to embed in the response, such as tags or custom field values.

Asset Id

The unique identifier of the asset to fetch.

Response Type

The response format expected from the API (e.g. application/json).

GET List Attachments on an Asset

/assets/{asset_id}/attachments

List all attachments associated with a given asset. Use this to view files attached to the asset.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Asset Id

The unique identifier of the asset whose attachments you want to list.

Response Type

The response format expected from the API (e.g. application/json).

GET List Custom Field Values for an Asset

/assets/{asset_id}/custom_field_values

Retrieve all custom field values for a specific asset. Use this to get the metadata values assigned to the asset.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Include

A comma-separated list of related resources to include, such as the custom field key details.

Asset Id

The unique identifier of the asset whose custom field values you want to list.

Response Type

The response format expected from the API (e.g. application/json).

GET List Tags for an Asset

/assets/{asset_id}/tags

List all tags applied to a specific asset. Use this to view the tags associated with the asset.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Include

A comma-separated list of related resources to include in the response.

Asset Id

The unique identifier of the asset whose tags you want to list.

Response Type

The response format expected from the API (e.g. application/json).

PUT Update an Asset

/assets/{asset_id}

Update the metadata or properties of an existing asset. Use this to change asset details such as name or description.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Asset Id

The unique identifier of the asset to update.

Response Type

The response format expected from the API (e.g. application/json).

Attachments (3)

DELETE Delete an Attachment

/attachments/{attachment_id}

Permanently delete an attachment from an asset. Use this to remove a file attachment.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Attachment Id

The unique identifier of the attachment to delete.

Response Type

The response format expected from the API (e.g. application/json).

GET Fetch an Attachment

/attachments/{attachment_id}

Retrieve details of a specific attachment. Use this to get attachment metadata and file information.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Page

The page number for paginated results, used when listing multiple attachments.

Per

The number of results per page for pagination.

Search

A search term to filter attachments by name or other attributes.

Fields

A comma-separated list of field names to include in the response.

Include

A comma-separated list of related resources to embed.

Attachment Id

The unique identifier of the attachment to fetch.

Response Type

The response format expected from the API (e.g. application/json).

PUT Update an Attachment

/attachments/{attachment_id}

Update the properties of an existing attachment. Use this to modify attachment metadata.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Attachment Id

The unique identifier of the attachment to update.

Response Type

The response format expected from the API (e.g. application/json).

Brandfolders (10)

POST Create Assets in a Brandfolder

/brandfolders/{brandfolder_id}/assets

Create a new asset within a specific brandfolder. Use this to upload or add an asset to a brandfolder, optionally placing it in a section.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Brandfolder Id

The unique identifier of the brandfolder where the asset will be created.

Response Type

The response format expected from the API (e.g. application/json).

Options (1)

Option Name

Description

Section Key

The key of the section within the brandfolder where the asset should be placed.

POST Create Custom Field Keys for a Brandfolder

/brandfolders/{brandfolder_id}/custom_field_keys

Create a new custom field key for a brandfolder. Use this to define a new metadata field that can be used across assets in that brandfolder.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Brandfolder Id

The unique identifier of the brandfolder where the custom field key will be created.

Response Type

The response format expected from the API (e.g. application/json).

POST Create a Collection in a Brandfolder

/brandfolders/{brandfolder_id}/collections

Create a new collection within a brandfolder. Use this to group assets into a collection for organization.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Brandfolder Id

The unique identifier of the brandfolder where the collection will be created.

Response Type

The response format expected from the API (e.g. application/json).

POST Create a Section in a Brandfolder

/brandfolders/{brandfolder_id}/sections

Create a new section within a brandfolder. Use this to add a section that can contain assets.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Brandfolder Id

The unique identifier of the brandfolder where the section will be created.

Response Type

The response format expected from the API (e.g. application/json).

GET Fetch a Brandfolder

/brandfolders/{brandfolder_id}

Retrieve details of a specific brandfolder. Use this to get brandfolder metadata and related information.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Fields

A comma-separated list of field names to include in the response.

Include

A comma-separated list of related resources to embed, such as collections or sections.

Brandfolder Id

The unique identifier of the brandfolder to fetch.

Response Type

The response format expected from the API (e.g. application/json).

GET List Assets in a Brandfolder

/brandfolders/{brandfolder_id}/assets

List all assets within a specific brandfolder. Use this to browse or search assets in a brandfolder with pagination and filtering.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Page

The page number for paginated results.

Per

The number of assets per page.

Search

A search term to filter assets by name or other attributes.

Fields

A comma-separated list of field names to include in the response.

Include

A comma-separated list of related resources to embed.

Brandfolder Id

The unique identifier of the brandfolder whose assets you want to list.

Response Type

The response format expected from the API (e.g. application/json).

GET List Collections in a Brandfolder

/brandfolders/{brandfolder_id}/collections

Retrieve a list of all collections within a specific brandfolder.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Fields

A comma-separated list of field names to include in the response.

Include

A comma-separated list of related resources to embed.

Brandfolder Id

The unique identifier of the brandfolder whose assets you want to list.

Response Type

The response format expected from the API (e.g. application/json).

GET List Custom Field Keys for a Brandfolder

/brandfolders/{brandfolder_id}/custom_field_keys

Retrieve a list of all custom field keys defined for a specific brandfolder.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Fields

A comma-separated list of field names to include in the response.

Include

A comma-separated list of related resources to embed.

Brandfolder Id

The unique identifier of the brandfolder whose assets you want to list.

Response Type

The response format expected from the API (e.g. application/json).

GET List Invitations to a Brandfolder

/brandfolders/{brandfolder_id}/invitations

Retrieve a list of all invitations sent for a specific brandfolder.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Fields

A comma-separated list of field names to include in the response.

Include

A comma-separated list of related resources to embed.

Brandfolder Id

The unique identifier of the brandfolder whose assets you want to list.

Response Type

The response format expected from the API (e.g. application/json).

GET List Sections in a Brandfolder

/brandfolders/{brandfolder_id}/sections

Retrieve a list of all sections within a specific brandfolder.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Include

A comma-separated list of related resources to embed.

Brandfolder Id

The unique identifier of the brandfolder whose assets you want to list.

Response Type

The response format expected from the API (e.g. application/json).

Collections (9)

POST Create Assets in a Collection

/collections/{collection_id}/assets

Add one or more assets to an existing collection.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Collection Id

The unique identifier of the collection to which assets should be added.

Response Type

The response format expected from the API (e.g. application/json).

POST Create an Invitation to a Collection

/collections/{collection_id}/invitations

Send a new invitation for a specific collection.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Collection Id

The unique identifier of the collection for which the invitation is being created.

Response Type

The response format expected from the API (e.g. application/json).

DELETE Delete a Collection

/collections/{collection_id

Permanently delete a specific collection.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Response Type

The response format expected from the API (e.g. application/json).

GET Fetch a Collection

/collections/{collection_id}

Retrieve the details of a single collection by its identifier.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Fields

A comma-separated list of field names to include in the response.

Include

A comma-separated list of related resources to embed.

Collection Id

The unique identifier of the collection to retrieve.

Response Type

The response format expected from the API (e.g. application/json).

GET List Assets in a Collection

/collections/{collection_id}/assets

Retrieve a list of all assets contained within a specific collection.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Page

The page number for paginated results.

Per

The number of assets per page.

Search

A search term to filter assets by name or other attributes.

Fields

A comma-separated list of field names to include in the response.

Include

A comma-separated list of related resources to embed.

Collection Id

The unique identifier of the collection whose assets should be listed.

Response Type

The response format expected from the API (e.g. application/json).

GET List Attachments in a Collection

/collections/{collection_id}/attachments

Retrieve a list of all attachments associated with a specific collection.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Include

A comma-separated list of related resources to embed.

Collection Id

The unique identifier of the collection whose attachments should be listed.

Response Type

The response format expected from the API (e.g. application/json).

GET List Collections

/collections

Retrieve a list of all collections accessible to the authenticated user.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Fields

A comma-separated list of field names to include in the response.

Include

A comma-separated list of related resources to embed.

Response Type

The response format expected from the API (e.g. application/json).

GET List Invitations to a Collection

/collections/{collection_id}/invitations

Retrieve a list of all invitations for a specific collection.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Fields

A comma-separated list of field names to include in the response.

Include

A comma-separated list of related resources to embed.

Collection Id

The unique identifier of the collection whose invitations should be listed.

Response Type

The response format expected from the API (e.g. application/json).

PUT Update a Collection

/collections/{collection_id}

Update the properties of an existing collection.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Collection Id

The unique identifier of the collection to update.

Response Type

The response format expected from the API (e.g. application/json).

Custom Fields (4)

DELETE Delete a Custom Field key

/custom_field_keys/{custom_field_key_id}

Permanently delete a custom field key and all its associated values.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Custom Field Key Id

The unique identifier of the custom field key to which the new custom field value belongs.

Response Type

The response format expected from the API (e.g. application/json).

DELETE Delete a Custom Field value

/custom_field_values/{custom_field_value_id}

Permanently delete a specific custom field value.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Custom Field Value Id

The unique identifier of the custom field value to delete.

Response Type

The response format expected from the API (e.g. application/json).

PUT Update a Custom Field Key

/custom_field_keys/{custom_field_key_id}

Update the properties of an existing custom field key.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Custom Field Key Id

The unique identifier of the custom field key to which the new custom field value belongs.

Response Type

The response format expected from the API (e.g. application/json).

PUT Update a Custom Field Value

/custom_field_values/{custom_field_value_id}

Update the value of a specific custom field value.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Custom Field Value Id

The unique identifier of the custom field value to update.

Response Type

The response format expected from the API (e.g. application/json).

Invitations (3)

DELETE Delete an Invitation

/invitations/{invitation_id}

Permanently delete a specific invitation.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Invitation Id

The unique identifier of the invitation to delete.

Response Type

The response format expected from the API (e.g. application/json).

GET Fetch an Invitation

/invitations/{invitation_id}

Retrieve details of a specific invitation by its ID.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Invitation Id

The unique identifier of the invitation to delete.

Response Type

The response format expected from the API (e.g. application/json).

GET List Invitations to a Portal

/portals/{portal_id}/invitations

List all invitations associated with a specific portal.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Portal Id

The unique identifier of the portal whose invitations to retrieve.

Response Type

The response format expected from the API (e.g. application/json).

Labels (7)

POST Create a Label

/brandfolders/{brandfolder_id}/labels

Create a new label within a specific brandfolder.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Brandfolder Id

The unique identifier of the brandfolder whose assets you want to list.

Response Type

The response format expected from the API (e.g. application/json).

DELETE Delete a Label

/labels/{label_id}

Permanently remove a label using its unique identifier.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Label Id

The unique identifier of the label to delete.

Response Type

The response format expected from the API (e.g. application/json).

GET Fetch a Label

/labels/{label_id}

Retrieve details of a specific label by its ID.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Label Id

The unique identifier of the label to fetch.

Response Type

The response format expected from the API (e.g. application/json).

GET List Assets in a Label

/labels/{label_id}/assets

List all assets assigned to a specific label.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Page

The page number for paginated results.

Per

The number of assets per page.

Search

A search term to filter assets by name or other attributes.

Fields

A comma-separated list of field names to include in the response.

Include

A comma-separated list of related resources to embed.

Label Id

The unique identifier of the label whose assets to list.

Response Type

The response format expected from the API (e.g. application/json).

GET List Labels

/brandfolders/{brandfolder_id}/labels

List all labels within a specific brandfolder.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Brandfolder Id

The unique identifier of the brandfolder whose assets you want to list.

Response Type

The response format expected from the API (e.g. application/json).

PUT Move a Label

/labels/{label_id}/move

Move a label to a different parent or position within the label hierarchy.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Label Id

The unique identifier of the label to move.

Response Type

The response format expected from the API (e.g. application/json).

PUT Update a Label

/labels/{label_id}

Update the properties of an existing label.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Label Id

The unique identifier of the label to update.

Response Type

The response format expected from the API (e.g. application/json).

Organizations (8)

POST Create a Brandfolder in an Organization

/organizations/{organization_id}/brandfolders

Create a new brandfolder within a specific organization.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Organization Id

The unique identifier of the organization where the brandfolder will be created.

Response Type

The response format expected from the API (e.g. application/json).

POST Create an Invitation to an Organization

/organizations/{organization_id}/invitations

Send an invitation to a user to join a specific organization.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Organization Id

The unique identifier of the organization to which the invitation belongs.

Response Type

The response format expected from the API (e.g. application/json).

GET Fetch an Organization

/organizations/{organization_id}

Retrieve details of a specific organization by its ID.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Fields

A comma-separated list of field names to include in the response.

Include

A comma-separated list of related resources to embed.

Organization Id

The unique identifier of the organization to fetch.

Response Type

The response format expected from the API (e.g. application/json).

GET List Assets in an Organization

/organizations/{organization_id}/assets

List all assets within a specific organization.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Page

The page number for paginated results.

Per

The number of assets per page.

Search

A search term to filter assets by name or other attributes.

Fields

A comma-separated list of field names to include in the response.

Include

A comma-separated list of related resources to embed.

Organization Id

The unique identifier of the organization whose assets to list.

Response Type

The response format expected from the API (e.g. application/json).

GET List Attachments in an Organization

/brandfolders/{brandfolder_id}/attachments

List all attachments within a specific brandfolder.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Page

The page number for paginated results.

Per

The number of assets per page.

Search

A search term to filter assets by name or other attributes.

Fields

A comma-separated list of field names to include in the response.

Include

A comma-separated list of related resources to embed.

Brandfolder Id

The unique identifier of the brandfolder whose assets you want to list.

Response Type

The response format expected from the API (e.g. application/json).

GET List Brandfolders in an Organization

/brandfolders

List all brandfolders accessible to the authenticated user.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Response Type

The response format expected from the API (e.g. application/json).

GET List Invitations to an Organization

/organizations/{organization_id}/invitations

List all invitations sent to a specific organization.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Organization Id

The unique identifier of the organization whose invitations to list.

Response Type

The response format expected from the API (e.g. application/json).

GET List Organizations

/organizations

List all organizations accessible to the authenticated user.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Fields

A comma-separated list of field names to include in the response.

Include

A comma-separated list of related resources to embed.

Response Type

The response format expected from the API (e.g. application/json).

Sections

GET Fetch a Section

/sections/{section_id}

Retrieve details of a specific section using its unique identifier.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Include

A comma-separated list of related resources to embed.

Section Id

Unique identifier of the section to fetch.

Response Type

The response format expected from the API (e.g. application/json).

Tags (3)

DELETE Delete a Tag

/tags/{tag_id

Permanently remove a tag from the system using its unique identifier.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Response Type

The response format expected from the API (e.g. application/json).

GET List Tags

/docs

Retrieve a list of all tags available in the system.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Page

The page number for paginated results.

Per

The number of assets per page.

Response Type

The response format expected from the API (e.g. application/json).

PUT Update a Tag

/tags/{tag_id}

Modify the properties of an existing tag identified by its unique identifier.

Parameters

Parameter Name

Description

Content Type

The content type of the request payload sent to the API (e.g. application/json).

headers

Additional HTTP header name/value pairs to include in the request.

Tag Id

Unique identifier of the tag to update.

Response Type

The response format expected from the API (e.g. application/json).

Uploads

GET Request an Upload URL

/upload_requests

Obtain a pre-signed URL for uploading a file to the storage service.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Response Type

The response format expected from the API (e.g. application/json).

User Permissions (4)

DELETE Delete a User Permission (revoke access)

/user_permissions/{user_permission_id}

Revoke a specific user permission by removing the permission record using its unique identifier.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

User Permission Id

Unique identifier of the user permission to delete.

Response Type

The response format expected from the API (e.g. application/json).

GET List User Permissions for a Brandfolder

/brandfolders/{brandfolder_id}/user_permissions

Retrieve all user permissions associated with a specific brandfolder.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Page

The page number for paginated results.

Per

The number of assets per page.

Brandfolder Id

The unique identifier of the brandfolder whose assets you want to list.

Response Type

The response format expected from the API (e.g. application/json).

GET List User Permissions for a Collection

/collections/{collection_id}/user_permissions

Retrieve all user permissions associated with a specific collection.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Page

The page number for paginated results.

Per

The number of assets per page.

Collection Id

The unique identifier of the collection to update.

Response Type

The response format expected from the API (e.g. application/json).

GET List User Permissions for an Organization

/organizations/{organization_id}/user_permissions

Retrieve all user permissions associated with a specific organization.

Parameters

Parameter Name

Description

headers

Additional HTTP header name/value pairs to include in the request.

Page

The page number for paginated results.

Per

The number of assets per page.

Organization Id

The unique identifier of the organization whose invitations to list.

Response Type

The response format expected from the API (e.g. application/json).