POST /collections/merge
This endpoint allows you to merge a forked collection back to its destination collection.
On successful creation of the collection, the response returns the collection name
, id
and uid
.
You need to specify the fork UID (as source
) and destination collection UID (as destination
) in the request body.
Optionally, you can also specify the merge strategy as either deleteSource
or updateSourceWithDestination
. Following is an explanation of the merge strategies
Merge Strategy | Behaviour |
---|---|
deleteSource | Forked collection is deleted after merging |
updateSourceWithDestination | Forked collection is up to date with changes in destination collection |
If the collections cannot be merged (due to conflicts), appropriate error messages will be returned.
Requires API Key as
X-Api-Key
request header orapikey
URL query parameter.
Servers
- https://api.getpostman.com
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
source |
String | No | |
destination |
String | No | |
strategy |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.