ATattentive
Segments

Partial update segment by external ID

Changed on

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

Scopes Required: [segments:Write]

Default Rate Limit: 100 requests per second

patch/v2/segments/external/{externalId}

Request

  • Base URL
    https://api.attentivemobile.com
  • Auth
    • HTTP bearer
    • or 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

Path parameters

externalIdstring required

External ID of the segment

Request body

namestring

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.

descriptionstring

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.

Example request

{
  "name": "Loyalty Gold Members Updated",
  "description": "Updated description"
}

Response

Segment updated successfully

externalIdstring

The external segment ID (client-facing identifier)

namestring

The name of the segment

descriptionstring

The description of the segment

createdstring date-time

When the segment was created (ISO 8601 format)

updatedstring date-time

When the segment was last updated (ISO 8601 format)

Example response

{
  "externalId": "loyalty_gold_2025",
  "name": "Loyalty Gold Members",
  "description": "Customers with gold loyalty status",
  "created": "2025-01-30T12:00:00Z",
  "updated": "2025-01-30T12:00:00Z"
}

Changes