---
title: "Update tenant custom headers"
method: POST
path: "/tenant/custom_headers"
tags: ["Tenant"]
---

# Update tenant custom headers

`POST /tenant/custom_headers`

## Request

- Base URL: `https://HOSTNAME:8887/api`
- URL: `https://HOSTNAME:8887/api/tenant/custom_headers`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/docs/tenant/custom_headers/post.ts> (a function with typed inputs; its response is checked against the schema)

Update tenant custom headers.

## Request body

- object: The added custom SIP headers and forwarded SIP headers in tenant scope.
  - `add` object[]
    - `name` string: The name of custom SIP header.
    - `value` string: The value of custom SIP header.
    - `scope` 'ALL' | 'TRUNK' | 'USER': The applied calls of custom SIP headers: Can be either: - `ALL`: Applies to all calls. - `TRUNK`: Applies to trunk calls. - `USER`: Applies to user calls.
  - `relay` object[]
    - `name` string: The name of custom SIP header.
    - `scope` 'ALL' | 'TRUNK' | 'USER': The applied calls of custom SIP headers: Can be either: - `ALL`: Applies to all calls. - `TRUNK`: Applies to trunk calls. - `USER`: Applies to user calls.

## Response `200`

OK

## Other responses

- `4XX`: Error

---

[API](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api.md) - [All operations](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/revisions/577415d4a3d5?raw)