API ReferenceData Clips

Create

Creates a new DataClip.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

X-Disable-Hooks"true"Required

Request

This endpoint expects an object.
namestringRequired
The name of the DataClip.
sourceSheetIdstringRequired
The ID of the source sheet.
descriptionstringOptional
A description of the DataClip.
collaboratorslist of stringsOptional
The list of collaborators.
sharedLinkAccessenumOptional
The type of shared link to generate for the DataClip.
Allowed values:

Response

This endpoint returns an object.
idstring
Data Clip ID
namestring
The name of the DataClip.
sourceSheetIdstring
The ID of the source sheet.
clipSheetIdstring
The ID of the sheet that is clipped from source sheet.
workbookIdstring
The ID of the workbook.
statusstring
The status of the DataClip.
createdBystring
The user who created the DataClip.
updatedAtdatetime
The date when the DataClip was updated.
createdAtdatetime
The date when the DataClip was created.
descriptionstring or null
A description of the DataClip.
mergedAtdatetime or null
The date when the DataClip was merged.
deletedAtdatetime or null
The date when the DataClip was deleted.
guestLinkUrlstring or null
A URL for guests to access the DataClip.
accessTokenstring or null
A signed token associated with the guest link.
sharedLinkAccessstring or null
Indicates the shared link access level, public or restricted

Errors