Update Subscriber’s Segment
The UpdateSubscriberSegment API in OCS.io facilitates the modification of a subscriber’s segment, allowing for customization to address specific operational needs.
| Please note that attributes are not versioned, meaning that when you update subscriber information, the new values take effect immediately. This change does not impact previously processed data. |
API Overview
Fields Required for Updating Subscriber’s Segment
The following table lists and describes the fields required to update a subscriber’s segment through the UpdateSubscriberSegment API:
| Field | Description |
|---|---|
subscriber |
ID (Ref ID / External ID) of the Subscriber. |
subscriberSegment |
New Segment of the Subscriber. Subscriber Segment must be configured. |
| Detailed API documentation and endpoint specifics are available here. |
Request Validations
The following validations are performed when updating a subscriber’s segment:
-
Subscriber must be provided in the request, it must be already created in the system and must not be in Deactivated State.
-
Subscriber Segment must be provided in the request, it must be configured in the system.
Update Subscriber’s Segment Example
Use the following request’s body to update a subscriber’s segment:
{
"requestId": "{{$guid}}",
"subscriber": {
"externalId": "subscriber_external_id"
},
"subscriberSegment": "new_subscriber_segment_code"
}The outcome of the API call is as follows:
-
The segment of the subscriber with external ID
subscriber_external_idis updated to configured segment with codenew_subscriber_segment_code.