Salsifyconnector v1.1

Version 1.1

Connector Overview: This page documents all 43 actions for the Salsifyconnector v1.1.

General (43)

PUT Add List Members

/lists/{list_id}/members

Adds one or more members to a specified list.

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.

List Id

Identifier for the list being updated. List ID can be found by navigating to the Salsify list; ID follows product_lists or digital_asset_lists. See List Membership Overview for how to find the list ID.

Response Type

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

Options (1)

Option Name

Description

Member Id

Salsify product ID for the products to be added to the list.

POST Bulk Create New Properties

/properties

Creates multiple new properties in a single request.

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.

Response Type

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

Options (4)

Option Name

Description

Salsify:id

Unique identifier for property. Used in report headers, channel mapping, etc. Cannot start with salsify, =, or _. Case sensitive.

Salsify:name

Property name, if different from ID. Best practice is for property ID and name to match. If not specified, property name will be filled with property ID value.

System Metadata

Include values for any system metadata you want to set for the property. See Properties Overview for full list.

Custom Metadata

Set any custom metadata you want to include with the property.

POST Bulk Create Products

/products

Creates multiple products in a single request.

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.

Response Type

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

Options (3)

Option Name

Description

Product Id

Property ID of the property that is set as the product ID role in Salsify. Product ID value cannot begin with =, _, or salsify. Must be unique, and is case sensitive.

Product Name

Property ID for the property that is set as the product name role in Salsify. Product name will be left blank if not included.

Additional Properties

Additional information to store in properties associated with the product, sent in value pairs of property_id : property_value. Property IDs that don't exist in the Salsify org will be created as default string data type. Accepts multiple property values as arrays.

POST Bulk Create Records

/records

Creates multiple records in a single request.

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.

Response Type

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

Options (3)

Option Name

Description

Record Id

Property ID of the property that is set as the record ID role in Salsify. Record ID value cannot begin with =, _, or salsify. Must be unique, and is case sensitive.

Record Name

Property ID for the property that is set as the record name role in Salsify. Record name will be left blank if not included.

Additional Properties

Additional information to store in properties associated with the record, sent in value pairs of property_id : property_value. Property IDs that don't exist in the Salsify org will be created with a default string data type. Accepts multiple property values as arrays.

DELETE Bulk Delete Products

/products

Deletes multiple products in a single request.

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.

Response Type

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

Options (1)

Option Name

Description

Product Id

Unique value that identifies product and stored in the property that holds the product identifier role in Salsify. Send as an array of product ID values; property id label is not sent.

DELETE Bulk Delete Properties

/properties

Deletes multiple properties in a single request.

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.

Response Type

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

Options (1)

Option Name

Description

Salsify:id

Unique identifier for each property, sent as an array.

DELETE Bulk Delete Records

/records

Deletes multiple records in a single request.

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.

Response Type

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

Options (1)

Option Name

Description

Record Id

Unique value that identifies records and stored in the property that holds the record identifier role in Salsify. Send as an array of record ID values; property id label is not sent.

GET Bulk Read Digital Assets

/digital_assets

Retrieves a list of digital assets.

Parameters

Parameter Name

Description

headers

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

Filter

Limit the scope of digital assets returned from the endpoint. Details on how to build filters are available here

Page

Page number

Per Page

Number of results per page

Response Type

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

GET Bulk Read Products

/products

Retrieves a list of products.

Parameters

Parameter Name

Description

headers

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

Filter

Limit the scope of products returned from the endpoint. Details on how to build filters are available here

Page

Page number

Per Page

Number of results per page

Response Type

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

GET Bulk Read Records

/records

Retrieves a list of records.

Parameters

Parameter Name

Description

headers

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

Filter

Limit the scope of records returned from the endpoint. Details on how to build filters are available here

Page

Page number

Per Page

Number of results per page

Record Type

Limit the scope to a specific record type

Response Type

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

PUT Bulk Update Products

/products

Updates multiple existing products in a single request.

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.

Response Type

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

Options (2)

Option Name

Description

Product Id

Value to identify product, stored in property with unique product identifier role in your Salsify organization.

Properties

Properties can be added in value pairs. {property_id} : {property_value} where property_id is a Salsify property, and property_value is the corresponding property value. If property_id does not exist in org, property will be created.

PUT Bulk Update Records

/records

Updates multiple existing records in a single request.

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.

Response Type

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

Options (2)

Option Name

Description

Record Id

Value to identify record, stored in property with unique record identifier role in your Salsify organization.

Properties

Properties can be added in value pairs. {property_id} : {property_value} where property_id is a Salsify property, and property_value is the corresponding property value. If property_id does not exist in org, property will be created.

PUT Bulk Upsert Digital Assets

/{organization_id}/digital_assets/_upsert

Creates or updates multiple digital assets in a single request, matching on a unique 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.

Organization Id

The Salsify organization's unique identifier. Visit your Salsify organization and pull from the URL path, immediately following /orgs/.

Response Type

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

Options (4)

Option Name

Description

Salsify:id

The identifier to use for the asset. A randomly generated ID is assigned if not specified.

Salsify:url

An HTTP(S) URL of a public image on the Internet.

Salsify:name

Digital asset name. The filename is used if not specified.

Additional Metadata

Additional optional metadata can be added in value pairs. {metadata_id} : {metadata_value} where metadata_id is a Salsify property, and metadata_value is the corresponding property value. If metadata_id does not exist in org, property will be created.

PUT Bulk Upsert Products

/products/_upsert

Upserts allow you to update and create a product in the same call.

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.

Response Type

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

Options (2)

Option Name

Description

Product Id

Value to identify product, stored in property with unique product identifier role in your Salsify organization.

Properties

Properties can be added in value pairs. {property_id} : {property_value} where property_id is a Salsify property, and property_value is the corresponding property value. If property_id does not exist in org, property will be created.

PUT Bulk Upsert Properties

/{organization_id}/properties/_upsert

Creates or updates multiple properties in a single request, matching on a unique 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.

Organization Id

The Salsify organization's unique identifier. Visit your Salsify organization and pull from the URL path, immediately following /orgs/

Response Type

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

Options (4)

Option Name

Description

Salsify:id

Unique identifier for property. Used in report headers, channel mapping, etc. Cannot start with salsify, =, or _. Case sensitive.

Salsify:name

Property name, if different from ID. Best practice is for property ID and name to match. If not specified, property name will be filled with property ID value.

Salsify:system Metadata

Include values for any system metadata you want to set for the property. See Properties Overview for full list.

Salsify:custom Metadata

Set any custom metadata you want to include with the property.

PUT Bulk Upsert Records

/records/_upsert

Upsert allows you to update and create a record in the same call.

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.

Response Type

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

Options (2)

Option Name

Description

Record Id

Value to identify record, stored in property with unique record identifier role in your Salsify organization.

Properties

Properties can be added in value pairs. {property_id} : {property_value} where property_id is a Salsify property, and property_value is the corresponding property value. If property_id does not exist in org, a property with that id will be created.

POST Create Multiple Digital Assets

/digital_assets

Creates multiple digital assets in a single request.

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.

Response Type

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

Options (4)

Option Name

Description

Salsify:source Url

A public-facing HTTP(S) URL for the digital asset file.

Salsify:id

The identifier to use for the asset. A randomly generated ID is assigned if not specified.

Salsify:name

Digital asset name. The filename is used if not specified.

Additional Metadata

Additional optional metadata (system or custom) can be added in value pairs. {metadata_id} : {metadata_value} where metadata_id is a Salsify property, and metadata_value is the corresponding property value. If metadata_id does not exist in org, property will be created.

POST Create Product1

/products/

Creates a single product with optional product identifier and name.

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.

Response Type

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

Options (3)

Option Name

Description

Prod A

Specifies the product identifier (e.g., 'Prod A') used to reference the product.

Product id

Specifies the unique product ID for the new product.

Product name

Specifies the display name of the new product.

POST Create Record

/records/

Creates a single record.

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.

Response Type

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

Options (2)

Option Name

Description

Record Name

Property ID for the property that is set as the record name role in Salsify. Record name will be left blank if not included.

Additional Properties

Additional information to store in properties associated with the record, sent in value pairs of property_id : property_value. Property IDs that don't exist in the Salsify org will be created as default string data type. Accepts multiple property values as arrays.

POST Create a Digital Asset & Metadata

/{organization_id}/digital_assets

Creates a digital asset along with its metadata in the specified 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 Salsify organization's unique identifier. Visit your Salsify organization and pull from the URL path, immediately following /orgs/

Response Type

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

Options (3)

Option Name

Description

Salsify:source Url

An HTTP(S) URL of a public image on the Internet.

Salsify:id

The identifier to use for the asset. A randomly generated ID is assigned if not specified.

Additional Metadata

Additional optional metadata (system or custom) can be added in value pairs. {metadata_id} : {metadata_value} where metadata_id is a Salsify property, and metadata_value is the corresponding property value. If metadata_id does not exist in org, property will be created.

POST Create a Mount Point

/imports/upload_mounts

Creates a mount point for importing files.

Parameters

Parameter Name

Description

headers

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

Authorization: bearer

User API Key

Content-type

Specifies the content type of the request body, such as 'application/json'.

Response Type

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

POST Creating a JSON Import from a Mount Point

/imports

Creates a JSON import job using data from a mount point.

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.

Authorization: bearer:

User API Key

Content-type

Specifies the content type of the request body, such as 'application/json'.

Response Type

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

DELETE Delete List Members

/lists/{list_id}/members

Removes one or more members from a specified list.

Parameters

Parameter Name

Description

headers

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

List Id

Identifier for the list being updated. List ID can be found by navigating to the Salsify list; ID follows product_lists or digital_asset_lists

Response Type

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

DELETE Delete Multiple Digital Assets

/digital_assets

Deletes multiple digital assets in a single request.

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.

Response Type

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

DELETE Delete Product

/products/{product_id}

Deletes a single product by its product ID.

Parameters

Parameter Name

Description

headers

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

Product Id

Unique value that identifies product and stored in the property that holds the product identifier role in Salsify. Send as an array of product ID values; property id label is not sent.

Response Type

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

DELETE Delete Property

/properties/{salsify:id}

Deletes a single property by its Salsify ID.

Parameters

Parameter Name

Description

headers

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

Salsify:id

Unique identifier for the property. Used in report headers, channel mapping, etc.

Response Type

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

DELETE Delete Record

/records/{product_id}

Deletes a single record by its product ID.

Parameters

Parameter Name

Description

headers

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

Record Id

Unique value that identifies records and stored in the property that holds the record identifier role in Salsify.

Response Type

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

GET Get Export Status

/export_runs/{export_id}

Retrieve the current status and details of a specific export run using its identifier.

Parameters

Parameter Name

Description

headers

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

Export Id

The ID for the export you want to retrieve status for. Found in the response from Start Export Run POST call.

Response Type

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

GET Getting the Status of an Import Run

/imports/runs/{import_run_id}

Check the progress and outcome of a specific import run by providing its run ID.

Parameters

Parameter Name

Description

headers

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

Import Run Id

the ID of the import run to retrieve status for

Authorization: bearer

User API Key

Content-type

Specifies the content type of the request body, such as 'application/json'.

Response Type

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

GET Read Digital Asset Metadata

/digital_assets/{asset_id}

Where a user has permission and the digital asset exists, complete digital asset JSON object is returned with its most current information.

Parameters

Parameter Name

Description

headers

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

Asset Id

Digital asset unique identifier.

Response Type

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

GET Read Product Record

/products/{salsify:id}

Fetch a single product record identified by its Salsify ID, including all associated properties.

Parameters

Parameter Name

Description

headers

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

Salsify:id

Salsify product ID

Response Type

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

GET Read Property

/properties/{salsify:id}

Retrieve a specific property definition by its Salsify ID, including its configuration details.

Parameters

Parameter Name

Description

headers

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

Salsify:id

Unique identifier for the property. Used in report headers, channel mapping, etc.

Response Type

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

GET Read Record

/records/{salsify:id}

Obtain a generic record from the system using its Salsify ID, returning its fields and values.

Parameters

Parameter Name

Description

headers

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

Salsify Id

Salsify record ID for uniquely identifying a record.

Response Type

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

GET Read Record Types

/record_types

Used to query for all available record types.

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).

POST Refresh Digital Assets

/<org_ID>/digital_assets/refresh

Trigger a refresh operation for all digital assets within the specified organization to update their metadata.

Parameters

Parameter Name

Description

headers

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

Salsify:id

The identifier to use for the asset.

Response Type

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

POST Start Export Run

/export_runs

Initiate a new export run based on a previously defined export configuration.

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.

Response Type

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

Options (9)

Option Name

Description

Entity Type

Defines the type of entity you want to export. Allowed Values: all product digital_asset attribute attribute_value

Format

Format file is output in. If not specified, default format for all entity_types is xlsx. Note that for entity_type all, the only valid output formats are json and jsonl. Allowed Values: json jsonl csv xlsx

Compress

If true is specified, returns a compressed file in gzip format. (.gz)

Include All Columns

Returns all content properties for product entities, or all custom metadata stored with digital asset entities. Default is true. Use properties to define the scope for false.

Include All Content Locales

If true, the export run will include data for every content locale; otherwise it will include data for the channel's content locale

Properties

For exports where include_all_columns is false, specify property IDs for properties to be included in the export and formatted as a single value of single quote and comma-separated values. ie. "'Property ID 1','Property ID 2',Property ID 3'"

Filter

Limit the scope of entities included in export file based on filter specifications. Details on how to build filters are available here

Sort Order

Sorts results in either ascending or descending order by. Allowed Values: asc desc

Sort Property

Sorts results by the values stored in the Salsify Property ID specified.

POST Starting an Import Run

/imports/{import_id}/runs

Begin a new import run for an existing import definition, processing data from the configured source.

Parameters

Parameter Name

Description

headers

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

Import Id

Identifier for the import run either created manually in the application for a csv/excel import or generated with a mount point creation.

Authorization: bearer

User API Key

Content-type

Specifies the content type of the request body, such as 'application/json'.

Response Type

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

PUT Update Digital Asset Metadata

/digital_assets/{salsify:id}

Modify the metadata (such as title, description, or tags) of a single digital asset identified by its Salsify ID.

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.

Salsify:id

The identifier for the digital asset you want to replace.

Response Type

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

Options (2)

Option Name

Description

Source Url

Public-facing, non-login URL for the location of the digital asset you want to replace the current asset with. Don't include if you aren't making an update to the digital asset's source.

Additional Custom Metadata

Additional optional custom metadata can be added in value pairs. {metadata_id} : {metadata_value} where metadata_id is a Salsify property, and metadata_value is the corresponding property value. If metadata_id does not exist in org, property will be created.

PUT Update Multiple Digital Assets

/digital_assets

Batch-update metadata for multiple digital assets at once by sending an array of asset objects with their IDs and updated fields.

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.

Response Type

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

Options (4)

Option Name

Description

Salsify:id

The identifier to use for the asset. A randomly generated ID is assigned if not specified.

Source Url

An HTTP(S) URL of a public image on the Internet.

Salsify:name

Digital asset name. The filename is used if not specified.

Additional Metadata

Additional optional metadata can be added in value pairs. {metadata_id} : {metadata_value} where metadata_id is a Salsify property, and metadata_value is the corresponding property value. If metadata_id does not exist in org, property will be created.

PUT Update Product

/products/{product_id}

Edit the properties and values of an existing product record using its product ID.

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.

Product Id

Unique value that identifies product and stored in the property that holds the product identifier role in Salsify. Send as an array of product ID values; property id label is not sent.

Response Type

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

Options (2)

Option Name

Description

Product Id

Value to identify product, stored in property with unique product identifier role in your Salsify organization.

Properties

Properties can be added in value pairs. {property_id} : {property_value} where property_id is a Salsify property, and property_value is the corresponding property value. If property_id does not exist in org, property will be created.

PUT Update Property

/properties/{salsify:id}

Change the configuration or attributes of a property definition identified by its Salsify ID.

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.

Salsify:id

Unique identifier for the property. Used in report headers, channel mapping, etc.

Response Type

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

Options (1)

Option Name

Description

Metadata Id

Property metadata can be added in value pairs. {metadata_id} : {metadata_value} where metadata_id is the metadata id being associated with the Salsify property, and metadata_value is the corresponding metadata value. If metadata_id does not exist in org, metadata property will be created.

PUT Update Record

/records/{record_id}

Update the fields and values of a generic record using its record ID.

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.

Record Id

Value to identify record, stored in property with unique record identifier role in your Salsify organization.

Response Type

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

Options (1)

Option Name

Description

Properties

Properties can be added in value pairs. {property_id} : {property_value} where property_id is a Salsify property, and property_value is the corresponding property value. If property_id does not exist in the org, the property will be auto-created. The record_id must also be included in the body parameters.

PUT Updating an Import to Point at a New Mount Point

/imports/{import_id}

Reconfigure an existing import to use a different mount point, changing the source location for future import runs.

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.

Import Id

Identifier for the import run either created manually in the App for a csv/excel import or generated with a mount point creation.

Authorization: bearer

User API Key

Content-type

Specifies the content type of the request body, such as 'application/json'.

Response Type

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