Segments

Update segment

Changed on Jun 24, 2026

Change the definition of the segment.

put/api/segments/{segment_id}

Request

Base URL
https://go.urbanairship.com
Auth
- HTTP basic
- or HTTP bearer
TypeScript
https://skmtc.dev/airship/apis/airship-api/docs/api/segments/:segment_id/put.ts
A function with typed inputs. Its response is checked against the schema.

Request body

display_namestring required

Human readable name for this segment. This will be used in the dashboard.

Response

Returned if the segment has been successfully updated.

okboolean required

Success.

operation_idstring uuid

A unique string identifying the operations that modify resources. Use the operation ID to locate and track grouped operations (i.e., a batch push operation may generate multiple push_id strings, but a single operation_id) or operations that change an existing resource.

Changes

Jun 24, 202638241778b0c1 Revision changes
- breaking
  added the new required request property ////////
- breaking
  added the new required request property ////////
- breaking
  added the new required request property ////////
- breaking
  added the new required request property ////////
- breaking
  added the new required request property ////////
- breaking
  added the new required request property ////////
- breaking
  added the new required request property ///////
- breaking
  added the new required request property ///////
- breaking
  added the new required request property ///////
- breaking
  added the new required request property ////
- breaking
  added the new required request property ////
- breaking
  added the new required request property ////
- breaking
  removed subschema #1: All selector subschema #2: Tag selector subschema #3: Segment selector subschema #4: Channel selector subschema #5: Named User selector subschema #6: Fire OS channel selector subschema #7: Android channel selector subschema #8: Open channel selector subschema #9: SMS sender selector subschema #10: SMS ID selector subschema #11: Static list selector subschema #12: Subscription List selector subschema #17: Alias selector subschema #18: APID selector subschema #20: Triggered selector from the ///// request property oneOf list
- breaking
  removed subschema #1: All selector subschema #2: Tag selector subschema #3: Segment selector subschema #4: Channel selector subschema #5: Named User selector subschema #6: Fire OS channel selector subschema #7: Android channel selector subschema #8: Open channel selector subschema #9: SMS sender selector subschema #10: SMS ID selector subschema #11: Static list selector subschema #12: Subscription List selector subschema #17: Alias selector subschema #18: APID selector subschema #20: Triggered selector from the ///// request property oneOf list
- breaking
  removed subschema #1: All selector subschema #2: Tag selector subschema #3: Segment selector subschema #4: Channel selector subschema #5: Named User selector subschema #6: Fire OS channel selector subschema #7: Android channel selector subschema #8: Open channel selector subschema #9: SMS sender selector subschema #10: SMS ID selector subschema #11: Static list selector subschema #12: Subscription List selector subschema #17: Alias selector subschema #18: APID selector subschema #20: Triggered selector from the //// request property oneOf list
- breaking
  removed subschema #1: All selector subschema #2: Tag selector subschema #3: Segment selector subschema #4: Channel selector subschema #5: Named User selector subschema #6: Fire OS channel selector subschema #7: Android channel selector subschema #8: Open channel selector subschema #9: SMS sender selector subschema #10: SMS ID selector subschema #11: Static list selector subschema #12: Subscription List selector subschema #17: Alias selector subschema #18: APID selector subschema #20: Triggered selector from the / request property oneOf list
This list may be incomplete.
Apr 12, 20225a2789287bfb Revision changes
- info
  added the new scene_completed enum value to the request property ///////
- info
  added the new scene_completed enum value to the request property ///////
- info
  added the new scene_completed enum value to the request property //////
- info
  added the new scene_completed enum value to the request property ///
- info
  added the new scene_displayed enum value to the request property ///////
- info
  added the new scene_displayed enum value to the request property ///////
- info
  added the new scene_displayed enum value to the request property //////
- info
  added the new scene_displayed enum value to the request property ///
- info
  added the new scene_incomplete enum value to the request property ///////
- info
  added the new scene_incomplete enum value to the request property ///////
- info
  added the new scene_incomplete enum value to the request property //////
- info
  added the new scene_incomplete enum value to the request property ///
- info
  added the new survey_displayed enum value to the request property ///////
- info
  added the new survey_displayed enum value to the request property ///////
- info
  added the new survey_displayed enum value to the request property //////
- info
  added the new survey_displayed enum value to the request property ///
- info
  added the new survey_not_submitted enum value to the request property ///////
- info
  added the new survey_not_submitted enum value to the request property ///////
- info
  added the new survey_not_submitted enum value to the request property //////
- info
  added the new survey_not_submitted enum value to the request property ///
- info
  added the new survey_submitted enum value to the request property ///////
- info
  added the new survey_submitted enum value to the request property ///////
- info
  added the new survey_submitted enum value to the request property //////
- info
  added the new survey_submitted enum value to the request property ///

Operation history (3 revisions)

Update segment

Request

Request body

Response 200OK

Changes

Response