Update Segment

PATCH {{baseUrl}}/api/segments/:id/

Update the name of a segment with the given segment ID.

Rate limits:
Burst: 1/s
Steady: 15/m
Daily: 100/d

Scopes: segments:write

Request Body

{"data"=>{"type"=>"segment", "id"=>"<string>", "attributes"=>{"name"=>"<string>", "is_starred"=>"<boolean>"}}}

HEADERS

KeyDatatypeRequiredDescription
revisionstring(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;data&quot;:{&quot;type&quot;:&quot;segment&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;attributes&quot;:{&quot;is_active&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is_processing&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is_starred&quot;:&quot;\u003cboolean\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;created&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updated&quot;:&quot;\u003cdateTime\u003e&quot;},&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;},&quot;relationships&quot;:{&quot;profiles&quot;:{&quot;data&quot;:[{&quot;type&quot;:&quot;profile&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;},{&quot;type&quot;:&quot;profile&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;}],&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;,&quot;related&quot;:&quot;\u003curi\u003e&quot;}},&quot;tags&quot;:{&quot;data&quot;:[{&quot;type&quot;:&quot;tag&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;},{&quot;type&quot;:&quot;tag&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;}],&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;,&quot;related&quot;:&quot;\u003curi\u003e&quot;}}}}}