Building a webhook integration? Read the webhook guide for signatures, retries, event schemas, and troubleshooting.

apiDeterministic

Update segment

PATCH /api/v1/segments

Patch selected fields on one draft Launchpad segment. Uses expectedUpdatedAt for conflict protection. Active segments must use campaign revision.

Parameters

workspaceIdrequired

string

No description.

segmentIdrequired

string

No description.

expectedUpdatedAtrequired

string

No description.

patchrequired

object

No description.

Example

REST requestbash

curl -X PATCH "https://app.pipeline.help/api/v1/segments" \
  -H "Authorization: Bearer $PIPELINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspaceId":"00000000-0000-4000-8000-000000000000","segmentId":"00000000-0000-4000-8000-000000000000","expectedUpdatedAt":"2026-01-01T00:00:00.000Z","patch":{}}'

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "segment": {
      "type": "object"
    }
  },
  "required": [
    "segment"
  ]
}

HTTP errors

401: Missing or invalid API key.
403: Authenticated but not permitted for the workspace or resource.
404: The requested resource was not found.