---
title: "createExternalSegment"
method: POST
path: "/v1/external_segment/metadata"
tags: ["ExternalSegments"]
---

# createExternalSegment

`POST /v1/external_segment/metadata`

## Request

- Base URL: `https://app.aptrinsic.com`
- URL: `https://app.aptrinsic.com/v1/external_segment/metadata`
- Auth: none declared
- TypeScript: <https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/docs/v1/external_segment/metadata/post.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `failIfExists` boolean

## Request body

- ExternalSegmentDto
  - `id` string
  - `externalId` string
  - `name` string
  - `description` string

## Response `200`

OK

- ExternalSegmentDto
  - `id` string
  - `externalId` string
  - `name` string
  - `description` string

---

[API](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api.md) - [All operations](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/revisions/e7b197b373d8?raw)