30-day challenge API Documentation

Create relations

POST https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/relations

Creates a new relation for an API version. Include the following in the request body:

relationType — An array that contains entity relations. The key value for this array must be the unclassified value.

You must include the following properties in the relationType array:

entityId — The collection's UID value.

Note:

The following is deprecated in Qodex API v10 and higher:

`relationType`	`entityId`
`documentation` and `test`	A collection UID value.
`environment`	An environment UID value.
`mock`	A mock ID value.
`monitor`	A monitor ID value.

The endpoint accepts multiple relationType arrays in a single call. For an example, see the example response documentation.

The documentation and test values returned in the response are the relation ID values, not the collection ID values.

Body PARAM

Key

Datatype

Required

Description

HEADERS

Key	Datatype	Required	Description
Content-Type	string

RESPONSES

status OK

{ "unclassified": [ "2e006451-e819-443f-97bc-d1635e51007f" ] }

Curl

curl -X POST 'https://api.getpostman.com/apis/undefined/versions/undefined/relations' -H 'Content-Type: application/json' -d '{"undefined":["undefined"]}'