Update segment
The following fields can be modified through this endpoint: <br><b>name, description, definition, owner, dataview ID, aamStatus</b><br><br>Note: "aamStatus" is used to "publish" a report suite segment to other products in the Experience Cloud. Description is always required when publishing with aamStatus. The report suite must already be pre-configured for AAM for publishing to succeed (see the "/segments/aamStatus/" endpoint for more information). <br>Format for aamStatus object:<br>"aamStatus":{"published":["rsid1","rsid2"]}<br><br>Example "defintion" for use in testing API below ("Page exists"):<br>"definition":{"func":"segment","container":{"func":"container","context":"hits","pred":{"func":"exists","description":"Page","val":{"func":"attr","name":"variables/page"}}},"version":[1,0,0]}<br><br>Response will be the newly modified segment object after the update request completes.<br><br><b><span style="text-decoration: underline;">SegmentResponse</span></b><br>A segment response will always include these default items:<br><b>id</b><br><br>Other attributes can be optionally requested through the 'expansion' field: <br><b>name</b>: Name of the segment<br><b>description</b>: Description of the segment<br><b>dataId</b>: Associated data ID of the segment<br><b>owner</b>: Owner of the segment<br><b>modified</b>: Date that the segment was last modified (ISO 8601)<br><b>definition</b>: Segment definition as JSON object<br><b>compatibility</b>: Products that the segment is compatible with<br><b>isDeleted</b>: Returns whether or not the segment is 'Deleted' (note that deleted segments are only returned if requested by ID)
Request
- Base URL: https://cja.adobe.io
- URL: https://cja.adobe.io/segments/{id}
- Auth: none declared. Required headers: Authorization, x-api-key, x-gw-ims-org-id
Path parameters
Segment ID to be updated
Query parameters
Comma-delimited list of additional segment metadata fields to include on response.
Locale
Use cached results
Headers
The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.
The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.
The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.
Request body
Response
Successful operation
Changes
No recorded changes to this operation across all 30 revisions of this API.