Create/get a contextual workspace folder

post

https://api.seismic.com/integration/v2/workspace/folders/createContextualFolder

Creates a contextual folder or gets the workspaceContentId for a contextual folder if it already exists. These contextual folders are identified by the combination of systemType, contextType, contextTypePlural, and contextId.

Caution: Folders Cannot be Deleted!
Any folders created with this API cannot be deleted including the folder for the systemType, contextTypePlural, and contextId, so take extreme caution when using this endpoint. Any typo in any of these fields will yield invalid non-removable folders. Each of the values is case sensitive.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

systemType

string

The CRM system type. Supported values are Salesforce, MicrosoftDynamicsCRM, Hubspot, OracleCX. Case-sensitive.

contextType

string

The singular CRM entity type (e.g., "Account", "Opportunity"). Case-sensitive; typos create non-removable folders.

contextTypePlural

string

The plural CRM entity type used in the folder path (e.g., "Accounts", "Opportunities"). Case-sensitive.

contextId

string

The unique identifier of the CRM entity instance this folder is linked to. Case-sensitive.

name

string

The display name for the contextual folder. Typically the CRM entity name for easy identification.

Headers

Content-Type

string

MIME type of the request body; must be 'application/json' for this endpoint.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

400Bad Request - the request body contains invalid or missing required fields. Validate the JSON payload against the operation schema (including required fields, value formats, and enum values) before retrying.

401Unauthorized - authentication credentials are missing, expired, or invalid. Acquire a fresh OAuth 2.0 bearer token and retry with the Authorization header set.

403Forbidden - the authenticated user lacks permission to perform this operation. Verify the required scope is granted and that the user has the necessary role on the target resource before retrying.