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

name

string

The name of the folder you would like to create. Often the name of the record in the external system. This name can be updated at any time as the folder is identified by the systemType+contextType+contextId.

systemType

string

This is typically one of the following: Salesforce, MicrosoftDynamicCRM, Sugar, Oracle. But there are no restrictions and any string can be used to specify a new system type for custom applications.

contextType

string

This is the singular form of the context such as "Opportunity" or "Account"

contextTypePlural

string

This is the plural form of the context such as "Opportunities" or "Accounts"

contextId

string

The ID of the record in the external system. For Salesforce we use 18 character record IDs such as 00646000009eMGLAA2. For Dynamics we use the record GUID such as 2DDE7B3B-2CAA-E811-A96A-000D3A1C5096. For Oracle we use the record number such as 3002 . For Sugar we use the record ID such as ecba9f86-4a4a-def6-359c-505a5b33f014.

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success