---
sourceDocument: Australia API Reference
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/api-reference

 Release :

    - australia

ft:locale :

    - en-US

ft:publication_title :

    - Australia API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Define a response header

# Define a REST API response header {#ariaid-title1}

Release version: Australia  
Updated March 12, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 minute to read  
Define one or more REST API response headers in a REST API.{#define-scripted-api-response-header__patch-rn-ap1-1}

## Before you begin

Role required: web_service_admin

## Procedure

1. Create a REST response header in one of the following ways.

   | Option | Procedure |
   | Create a response header from a REST API | 1. Navigate to AllSystem Web ServicesScripted REST APIs. 2. Select a scripted REST API record. 3. In the Response Headers related list, select New. {#define-scripted-api-response-header__ol_lh2_pwc_j3c} |
   | Create a response header and associate it with a REST API | Navigate to AllFilter and enter <kbd class="ph userinput">sys_ws_response_header.form</kbd>. 1. Enter <kbd class="ph userinput">sys_ws_response_header.form</kbd> in the filter navigator. 2. In the API field, select or enter the API to associate with the response header. {#define-scripted-api-response-header__ol_vbp_ggc_l3c} |
   |-|-|

   {#define-scripted-api-response-header__choicetable_rv3_mwc_j3c}
2. In the Header Name field, add the name of the new header.
3. In the Example value field, enter an example of a valid header value.
4. Select Submit.
5. Repeat these steps for each response header that you want to define.

## Result

The response headers that you added are included in the exportable OpenAPI specification in the REST API Explorer with a `type: string` schema definition. For more information about exporting OpenAPI
specifications, see [Export to OpenAPI specification](https://servicenow-prod.fluidtopics.net/VM1BPwWaXiyDxp0N9N0zPg "Export a REST API as an OpenAPI specification to import it into another web services tool.").

*[\>]: and then