Postman

Creates a request in a collection. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** It is recommended that you pass the \`name\` property in the request body. If you do not, the system uses a null value. As a result, this creates a request with a blank name.

createCollectionRequest

Creates a request response in a collection. For a complete list of request body properties, refer to the **Response** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** It is recommended that you pass the \`name\` property in the request body. If you do not, the system uses a null value. As a result, this creates a response with a blank name.

createCollectionResponse

Creates a component in the team's component library and seeds its first draft with the content you provide. Use this when a team wants a reusable schema, parameter, response, or security scheme that specifications can reference instead of redefining. The component starts active and unpublished: the content lands in its draft only. Call createComponentVersion afterwards to publish it and make it referenceable. Do not use this tool to edit an existing component's content; use updateComponentDraft instead. Requires a Postman Enterprise plan.

createComponent

Publishes the component's current draft as a new immutable version under the \`label\` you supply, making it referenceable by the team's specifications. Labels must be unique per component. Publishing cannot be undone and the resulting version cannot be edited — publish another version to supersede it. Archived components cannot be published; restore them with updateComponent first. Do not use this tool to save work in progress; use updateComponentDraft instead. Requires a Postman Enterprise plan.

createComponentVersion

Creates a comment on a folder. To create a reply on an existing comment, include the \`threadId\` property in the request body. **Note:** This endpoint accepts a max of 10,000 characters.

createFolderComment

Creates a mock server in a collection. - Pass the collection UID (ownerId-collectionId), not the bare collection ID. - If you only have a \`collectionId\`, resolve the UID first: 1) Prefer GET \`/collections/{collectionId}\` and read \`uid\`, or 2) Construct \`{ownerId}-{collectionId}\` using ownerId from GET \`/me\`: - For team-owned collections: \`ownerId = me.teamId\` - For personal collections: \`ownerId = me.user.id\` - Use the \`workspace\` query to place the mock in a specific workspace. Prefer explicit workspace scoping.

createMock

Creates a monitor. **Note:** - You cannot create monitors for collections added to an API definition. - If you do not pass the \`workspace\` query parameter, the system creates the monitor in the oldest personal Internal workspace you own.

createMonitor

Creates a Postman Package Library package and its initial index script. Use this when you want to add reusable JavaScript functions, tests, or utilities for a team to import into Postman scripts. A workspace ID is required to identify the workspace where the package is created. Do not use this tool to modify an existing package; use updatePackage instead.

createPackage

The request ID must contain the team ID as a prefix, in \`teamId-requestId\` format. For example, if you're creating a comment on collection ID \`24585957-7b2c98f7-30db-4b67-8685-0079f48a0947\` (note on the prefix), and the collection request's ID is \`2c450b59-9bbf-729b-6ac0-f92535a7c336\`, then the \`{requestId}\` must be \`24585957-2c450b59-9bbf-729b-6ac0-f92535a7c336\`.

createRequestComment

Creates a comment on a response. To create a reply on an existing comment, include the \`threadId\` property in the request body. **Note:** This endpoint accepts a max of 10,000 characters.

createResponseComment

Creates a server response on a mock server. Server responses simulate 5xx server-level failures (e.g. 500, 503) that are agnostic to any specific route — when active, every request to the mock returns this response. - \`statusCode\` must be a 5xx value (500–599). - \`body\` is a raw string — pass the response body exactly as the mock should return it (e.g. a JSON string like \`"{\"message\":\"error\"}"\` or plain text). - \`language\` controls syntax highlighting in the Postman UI (\`json\`, \`xml\`, \`html\`, \`javascript\`, \`text\`). It does not affect the actual response Content-Type — set that via \`headers\` instead. - \`headers\` is an array of \`{key, value}\` pairs for response headers (e.g. \`[{"key": "Content-Type", "value": "application/json"}]\`). - You can create multiple server responses per mock, but only one can be active at a time. Creating a response does NOT automatically activate it — call \`updateMock\` with \`config.serverResponseId\` set to the new response's \`id\` to activate it.

createMockServerResponse

Creates an API specification in Postman's [Spec Hub](https://learning.postman.com/docs/design-apis/specifications/overview/). Specifications can be single or multi-file. **Note:** - Postman supports OpenAPI (2.0, 3.0, and 3.1), AsyncAPI (2.0 and 3.0), protobuf (2 and 3), GraphQL, and Smithy specifications. - If the file path contains a \`/\` (forward slash) character, then a folder is created. For example, if the path is the \`components/schemas.json\` value, then a \`components\` folder is created with the \`schemas.json\` file inside. - Multi-file specifications can only have one root file. - Files cannot exceed a maximum of 12 MB in size.

createSpec

Creates a file for an OpenAPI or a protobuf 2 or 3 specification. **Note:** - If the file path contains a \`/\` (forward slash) character, then a folder is created. For example, if the path is the \`components/schemas.json\` value, then a \`components\` folder is created with the \`schemas.json\` file inside. - Creating a spec file assigns it the \`DEFAULT\` file type. - Multi-file specifications can only have one root file. - Files cannot exceed a maximum of 10 MB in size.

createSpecFile

Creates a new Postman team in the organization. \`name\` accepts only alphanumeric characters and spaces. This creates a billable organizational unit and is not something to do speculatively — only call it on an explicit, specific instruction to create a team, never to satisfy a vaguer request such as organizing or setting up a workspace. Use createWorkspace for that instead.

createTeam

Creates a new [workspace](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/). **Note:** - This endpoint returns a 403 \`Forbidden\` response if the user does not have permission to create workspaces. [Admins and Super Admins](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles) can configure workspace permissions to restrict users and/or user groups from creating workspaces or require approvals for the creation of team workspaces. - Private and [Partner Workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) are available on Postman [**Team** and **Enterprise** plans](https://www.postman.com/pricing). - There are rate limits when publishing public workspaces. - Public team workspace names must be unique. - The \`teamId\` property must be passed in the request body if [Postman Organizations](https://learning.postman.com/docs/administration/onboarding-checklist) is enabled.

createWorkspace

Publishes an update in a workspace, notifying everyone watching it. Use this to announce a breaking change, a release, or a deprecation to the workspace's consumers. This notifies real people, so only post when explicitly asked to announce something, and post the message you were given rather than a summary you composed. It does not change the workspace itself — use updateWorkspace for settings.

createWorkspaceUpdate

Creates a system environment for the team. \`name\` and \`color\` (a six-digit hex code such as \`#00FF00\`) are both required, and the name must be unique within the team — a duplicate returns 409. Optionally set \`label\` (lowercase alphanumerics, hyphens, and underscores only), \`description\`, and \`isProduction\`. Do not use this tool to create a Postman environment with variables; use createEnvironment instead. Requires a Postman Enterprise plan.

createApiCatalogSystemEnvironment

Creates an access request against a team — to join it, to raise a user's role, to add members, or to request team role access to another team. This asks for a privilege change on someone's behalf, and if team discovery is enabled the request is approved automatically, which means it can grant access with no human in the loop. Only call it on an explicit request from the person the access is for.

createAccessRequest

Creates an environment. **Note:** - The request body size cannot exceed the maximum allowed size of 30MB. - If you receive an HTTP \`411 Length Required\` error response, manually pass the \`Content-Length\` header and its value in the request header. - If you do not include the \`workspace\` query parameter, the system creates the environment in the oldest personal Internal workspace you own. - Only [shared variable](https://learning.postman.com/docs/use/send-requests/variables/variables/#share-variable-values) values can be modified through the Postman API. A shared variable is an environment variable with its value synced and stored in the Postman cloud, and can be accessed by your teammates in the environment's workspace.

createEnvironment

Deletes a collection.

deleteCollection

Deletes a folder in a collection.

deleteCollectionFolder

Deletes a request in a collection.

deleteCollectionRequest

Deletes a response in a collection.

deleteCollectionResponse

Deletes a comment from a collection. On success, this returns an HTTP \`204 No Content\` response. **Note:** Deleting the first comment of a thread deletes all the comments in the thread.

deleteCollectionComment

Deletes a comment from a folder. On success, this returns an HTTP \`204 No Content\` response. **Note:** Deleting the first comment of a thread deletes all the comments in the thread.

deleteFolderComment

Deletes a mock server. - Resource: Mock server entity. This is destructive. - Ensure you are targeting the correct mock ID.

deleteMock

Deletes a monitor.

deleteMonitor

Deletes a package and its associated index script content. This operation returns no content and also succeeds when the package no longer exists. Do not use this tool to clear or replace script content while retaining the package; use updatePackage instead.

deletePackage

Deletes a comment from a request. On success, this returns an HTTP \`204 No Content\` response. **Note:** Deleting the first comment of a thread deletes all the comments in the thread.

deleteRequestComment

Deletes a comment from a response. On success, this returns an HTTP \`204 No Content\` response. **Note:** Deleting the first comment of a thread deletes all the comments in the thread.

deleteResponseComment

Deletes a server response from a mock server. - If this server response is currently active (\`config.serverResponseId\` on the mock), deleting it will not automatically deactivate it. Call \`updateMock\` with \`config.serverResponseId: null\` first to deactivate. - This action is destructive and cannot be undone.

deleteMockServerResponse

Deletes an API specification. On success, this returns an HTTP \`204 No Content\` response.

deleteSpec

Deletes a file in an API specification. On success, this returns an HTTP \`204 No Content\` response.

deleteSpecFile

Deletes an existing workspace.

deleteWorkspace

Deletes a workspace update. This removes an announcement watchers may already have seen and cannot be undone. Prefer patchWorkspaceUpdate to correct a mistake — deleting leaves consumers with no record of a change they were told about. Only delete on an explicit instruction.

deleteWorkspaceUpdate

Deletes an SDK record and the stored archive behind it. Returns 204 with no body on success. Anyone still holding a download URL loses access to the artifact. This cannot cancel a generation job that is still running — a job in progress has to finish first. Only call this on an explicit instruction naming the SDK. Requires a Postman Team or Enterprise plan.

deleteSdk

Deletes an environment.

deleteEnvironment

Creates a duplicate of the given collection in another workspace. Use the GET \`/collection-duplicate-tasks/{taskId}\` endpoint to get the duplication task's current status.

duplicateCollection

Creates a collection from the given API specification. The specification must already exist or be created before it can be used to generate a collection. The response contains a polling link to the task status.

generateCollection

Starts an SDK generation job for one language from a collection or a specification. Returns 202 with a job record — the SDK does not exist yet. Poll getSdk and wait for \`buildStatus\` to reach \`succeeded\` before trying to download it. The request body depends on the \`language\` you pick, so send only the properties that language accepts. One call generates one language; call it once per language rather than expecting a bundle. Requires a Postman Team or Enterprise plan.

createSdk