SAsalsify

Bulk Create New Properties

post/{org_id}/properties

Request

  • Base URL
    https://app.salsify.com/api/v1/orgs
  • URL
    https://app.salsify.com/api/v1/orgs/{org_id}/properties
  • Auth
    API key in header Authorization

Path parameters

org_idstring required

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

Request body

salsify:idstring required

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

salsify:namestring

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_metadatastring

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

custom_metadatastring

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

Response

200

salsify:idstring
salsify:namestring
salsify:data_typestring
salsify:entity_typesobject[]
salsify:is_facetableboolean
salsify:attribute_groupstring
salsify:positionunknown
salsify:help_textstring
salsify:manage_permissionsunknown
salsify:read_permissionsunknown
salsify:hidden_permissionsunknown
salsify:created_atstring
salsify:updated_atstring
salsify:typestring
salsify:system_idstring

Example response

[
  {
    "salsify:id": "test_ID",
    "salsify:name": "test_name",
    "salsify:data_type": "string",
    "salsify:is_facetable": true,
    "salsify:attribute_group": "General",
    "salsify:help_text": "This is a test property",
    "salsify:created_at": "2018-09-10T13:43:12.128Z",
    "salsify:updated_at": "2018-09-10T13:43:12.128Z",
    "salsify:type": "property",
    "salsify:system_id": "s-999-999-999-999"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.