API ReferenceCollections

Transfer responses

View as MarkdownOpen in Claude
Copies or moves responses into a request.

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
idslist of stringsRequired
A list of collection request, response, or folder UIDs to transfer.
modeenumRequired
The transfer operation to perform.
Allowed values:
targetobjectRequired
Information about the item transfer's destination location.
locationobjectRequired

The transferred items’ placement in the target destination:

  • For start or end — Do not include the model and id values.
  • For before or after — Include the model and id properties.

Response

Successful Response
idslist of stringsOptional
A list of the transferred collection request, response, or folder UIDs.

Errors

400
Bad Request Error
500
Internal Server Error