Add properties to parameters and headers with an API collection

Types in collections is available with Postman Professional and Enterprise plans.

After you turn on types in a collection, you can add properties to parameters and headers. Properties can include data type, format, default value, and possible values. You can also specify if a component is required. Details you add will appear in the collection's documentation.

If you're on an Enterprise plan, you can also design your API in a specification in Spec Hub. Then you can generate a collection from your specification, turning on types for the collection. Properties are defined for your request parameters and headers in the generated collection based on your specification. If the collection was generated from an OpenAPI 3.0 specification, you can keep the collection in sync with your latest changes to the specification.

To add properties to a parameter or header, do the following:

1. Turn on types for your collection.

2. Open a request and select the Params or Headers tab. Add any parameters or headers as needed.

3. Hover over a query or path parameter or a header and select Add more properties.

   

4. Specify details for the parameter or header:

   • Type - Select the component's data type (string, integer, number, or boolean).
   • Required - Turn on if the component is required, or turn off if it's optional.
   • Deprecated - Turn on if the component is deprecated. A deprecated parameter or header is still functional, but its usage is discouraged because support may be discontinued.
   • Default value - Specify the default value for the component.
   • Possible enum values - (All types except boolean) Enter the allowed values for the component (enumerations), selecting Enter after each item.
   

5. Specify optional details depending on the component type:

   • Type string:

     • Format - Select the data format for the string (for example, date, time, or email).
     • Pattern - Enter allowed data patterns for the component using regex (regular expressions). You can't enter a pattern if you selected a format for the string.
     • Min length - Enter the minimum length for the component.
     • Max length - Enter the maximum length for the component.

   • Type integer or number:

     • Min value - Enter the minimum value for the component.
     • Max value - Enter the maximum value for the component.

6. Select Save to save the changes to your request.