---
title: "Partial update segment by external ID"
method: PATCH
path: "/v2/segments/external/{externalId}"
tags: ["Segments"]
---

# Partial update segment by external ID

`PATCH /v2/segments/external/{externalId}`

## Request

- Base URL: `https://api.attentivemobile.com`
- URL: `https://api.attentivemobile.com/v2/segments/external/{externalId}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://ui-devel.attentivemobile.com/integrations/oauth-install?client_id={clientId}&redirect_uri={redirectUri}&scope={scope}`
    - Token URL: `https://api.attentivemobile.com/v1/authorization-codes/tokens` scopes: `segments:write`

Partially updates an existing segment. Only provided fields will be updated.

Scopes Required: [segments:Write]

Default Rate Limit: 100 requests per second

## Path parameters

- `externalId` string, required

## Request body

- PatchSegmentRequest
  - `name` string: The name of the segment. If provided, cannot be empty or whitespace only and must be at most 240 characters. Leading and trailing whitespace will be trimmed. At least one field (name or description) must be provided for PATCH.
  - `description` string: The description of the segment. If provided, cannot be empty or whitespace only, must be at least 2 characters, and at most 500 characters. Leading and trailing whitespace will be trimmed. At least one field (name or description) must be provided for PATCH.

## Response `200`

Segment updated successfully

- SegmentResponse
  - `externalId` string: The external segment ID (client-facing identifier)
  - `name` string: The name of the segment
  - `description` string: The description of the segment
  - `created` string, date-time: When the segment was created (ISO 8601 format)
  - `updated` string, date-time: When the segment was last updated (ISO 8601 format)

## Other responses

- `400`: Bad request - invalid parameters
- `401`: Unauthorized - invalid or missing token
- `403`: Access denied - insufficient permissions
- `404`: Segment not found
- `429`: Too many requests - rate limit exceeded
- `500`: Internal server error

## Changes

- **2026-11-03** `2f49ffff7d65`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/attentive/apis/attentive-api-v2/changes/v2/segments/external/:externalId/patch.md)

---

[API](https://skmtc.dev/attentive/apis/attentive-api-v2.md) - [All operations](https://skmtc.dev/attentive/apis/attentive-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/attentive/apis/attentive-api-v2/revisions/2f49ffff7d65?raw)