Update a segment
PATCH
Changes the fields sent. Editing an organization-wide segment, or moving one to scope: org, needs the reach creating one takes (403 otherwise); a segment whose creator was deleted must stay public (400).
Requires segments:write on the site (an API key, or a signed-in member's role). Share links: 401.
header
x-api-key<token>An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).
Scope: segments:write
siteId*stringid*stringMatch
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidapplication/json- body
name?stringLength
1 <= length <= 80description?|nullfilters?array<>Items
1 <= items <= 20isPublic?booleanscope?stringValue in
"site""org"OK
application/json- response
data*curl -X PATCH 'https://pilotfox.app/api/v1/sites/string/segments/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'Content-Type: application/json' \ -d '{}'Example Response200
{ "data": { "id": "string", "name": "string", "description": "string", "filters": [ { "dim": "string", "op": "eq", "values": [] } ], "isPublic": true, "scope": "site", "createdBy": "string", "createdAt": "string", "updatedAt": "string" }}