Recorder/Survey

Clone Recorder

Clone Recorder to copy all the settings from the existing recorders

All the required fields are as below:

recorderId - Pass the recorderId from the existing recorder

Optional:

name - New name for the recorder. If not pass, it will take the existing recorder name and add (clone) to the new recorder

description - New description for the recorder. If not pass, it will take the existing recorder description as is.

folderId - IMPORTANT! We recommend to pass the folderId to ensure the recordings save in the specific folder. If not pass, it will take the existing recorder folderId setting.

If you need to change any other settings, we recommend to use the Create Recorder API call.

post/recorder/clone

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/recorder/clone
  • Auth: API key in header x-speakai-key and API key in header x-access-token

Request body

recorderIdstring required

Name the recorder you want to copy. Required. An empty or whitespace-only value is rejected. A recorderId that matches no recorder returns 404 with 'Recorder not found'.

namestring

Name the copy. Optional, empty string allowed. If you leave it out or send an empty string, the copy is named after the source recorder with ' (Clone)' appended.

descriptionstring

Describe the copy. Optional, empty string allowed. If you leave it out or send an empty string, the copy inherits the source recorder's description.

folderIdstring

Put the copy in this folder. Optional, empty string allowed. If you leave it out or send an empty string, the copy stays in the source recorder's folder. A folderId that matches no folder returns 404 with 'Folder not found. Please create or select a valid folder Id.'

Response

OK

statusstring

Changes

No recorded changes to this operation across all 2 revisions of this API.