Skip to content
AchaduDevelopers
Operational APIGo to website
Dashboard
Developers/API/segment_update
Segments

Update segment

Updates the segment's identity, distribution and showcase.

PATCH/segments/{id}segments:write

Request

idstring · pathResource identifier.mandatory
namestring · bodySegment name.optional
slugstring · bodyPublic slug.optional
descriptionstring · bodyDescription.optional
store_namestring · bodyStorefront name.optional
store_taglinestring · bodyPhrase from the window.optional
store_colorstring · bodyMain color.optional
auto_expandboolean · bodyEnables automatic expansion.optional
distributionstring · bodyDistribution strategy.optional
waitlistboolean · bodyActivates queue.optional

Example

curl
curl -X PATCH 'https://achadu.com/api/v1/segments/resource_id' \
+  -H 'Authorization: Bearer ach_live_...' \
+  -H 'Accept: application/json' \
+  -H 'Content-Type: application/json' \
+  --data '{
  "name": "My integration",
  "slug": "string",
  "description": "string"
}'

Answer

200Operation completed
4xxError with code, message and request_id