Publish documentation

PUT

/collections/:collectionId/public-documentations

PUT

/collections/:collectionId/public-documentations

$ curl -X PUT https://api.getpostman.com/collections/12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2/public-documentations \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "customColor": {
>     "highlight": "EF5B25",
>     "rightSidebar": "303030",
>     "topBar": "FFFFFF"
>   },
>   "customization": {
>     "metaTags": [
>       {
>         "name": "title",
>         "value": "Billing API"
>       },
>       {
>         "name": "description",
>         "value": "This documentation contains the endpoints for the Billing API."
>       }
>     ],
>     "appearance": {
>       "default": "dark",
>       "themes": [
>         {
>           "name": "dark",
>           "colors": {
>             "highlight": "EF5B25",
>             "rightSidebar": "303030",
>             "topBar": "FFFFFF"
>           },
>           "logo": "<s3_url>/<cloudfront_url>"
>         },
>         {
>           "name": "light",
>           "colors": {
>             "highlight": "EF5B25",
>             "rightSidebar": "303030",
>             "topBar": "FFFFFF"
>           },
>           "logo": "<s3_url>/<cloudfront_url>"
>         }
>       ]
>     }
>   },
>   "environmentUid": "12345678-f84a5105-a495-49db-aa6b-db02c9ed1023",
>   "documentationLayout": "classic-single-column"
> }'

1 {
2   "published": true,
3   "documentationLayout": "classic-single-column",
4   "customization": {
5     "metaTags": [
6       {
7         "name": "description",
8         "value": "This documentation contains the endpoints for the Billing API."
9       },
10       {
11         "name": "title",
12         "value": "Billing API"
13       }
14     ],
15     "appearance": {
16       "default": "dark",
17       "themes": [
18         {
19           "name": "dark",
20           "colors": {
21             "highlight": "EF5B25",
22             "rightSidebar": "303030",
23             "topBar": "FFFFFF"
24           },
25           "logo": "<s3_url>/<cloudfront_url>"
26         },
27         {
28           "name": "light",
29           "colors": {
30             "highlight": "EF5B25",
31             "rightSidebar": "303030",
32             "topBar": "FFFFFF"
33           },
34           "logo": "<s3_url>/<cloudfront_url>"
35         }
36       ]
37     }
38   },
39   "publishDate": "2025-03-24T17:33:10.000Z",
40   "publisherId": "12345678",
41   "environmentUid": "12345678-f84a5105-a495-49db-aa6b-db02c9ed1023",
42   "customColor": {
43     "highlight": "EF5B25",
44     "rightSidebar": "303030",
45     "topBar": "FFFFFF"
46   },
47   "publicUrl": "https://documenter.getpostman-beta.com/view/12345678/6n31uVF",
48   "id": "6n31uVF",
49   "collectionId": "ea39a259-0c9b-4a5c-a2e6-bddadb8f8e6f"
50 }

Publishes a collection’s documentation. This makes it publicly available to anyone with the link to the documentation.

Note:

Your Postman plan impacts your use of these endpoints:
- For Free and Solo users, you must have permissions to edit the collection.
- If API Governance and Security is enabled for your Enterprise team, only users with the Community Manager role can publish documentation.
Publishing is only supported for collections with HTTP requests.
You cannot publish a collection added to an API.

Publishes a collection's documentation. This makes it publicly available to anyone with the link to the documentation. **Note:** - Your [Postman plan](https://www.postman.com/pricing/) impacts your use of these endpoints: - For **Free** and **Solo** users, you must have permissions to edit the collection. - If [API Governance and Security](https://learning.postman.com/docs/api-governance/configurable-rules/configurable-rules-overview/) is enabled for your [**Enterprise**](https://www.postman.com/pricing/) team, only users with the [Community Manager role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles) can publish documentation. - Publishing is only supported for collections with HTTP requests. - You cannot publish a collection added to an API.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

collectionIdstringRequiredformat: "uid"

The collection's unique ID.

Request

This endpoint expects an object.

customColorobjectRequired

The theme’s colors, in six digit hexcode. The values in this object must match the hexcode values of either the light or dark theme defined in the appearance object.

customizationobjectRequired

Information about the documentation's customization.

environmentUidstringOptionalformat: "uid"

The unique ID of the environment to publish with the documentation. The initial values of all variables are published with the documentation. Make certain they don't contain sensitive information such as passwords or tokens.

documentationLayoutenumOptionalDefaults to classic-single-column

The documentation’s default layout style:

classic-single-column — Displays sample code inline beneath each request.
classic-double-column — Displays sample code in a column next to the documentation.

Response

Successful Response

publishedboolean

If true, the documentation is published.

documentationLayoutstring

The documentation's default layout style.

customizationobject

Information about the documentation's customization.

publishDatedatetime

The date and time at which the documentation was published.

publisherIdstring

The user ID of the user that published the documentation.

environmentUidstringformat: "uid"

The unique ID of the environment published with the collection documentation.

customColorobject

The theme’s colors, in six digit hexcode. The values in this object must match the hexcode values of either the light or dark theme defined in the appearance object.

publicUrlstringformat: "url"

The public URL of the published documentation.

idstring

The published documentation's ID.

collectionIdstring

The collection's ID.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error