Update Customer’s Segment

The UpdateCustomerSegment API in OCS.io facilitates the modification of a customer’s segment, allowing for customization to address specific operational needs.

Please note that attributes are not versioned, meaning that when you update customer information, the new values take effect immediately. This change does not impact previously processed data.

API Overview

Fields Required for Updating Customer’s Segment

The following table lists and describes the fields required to update a customer’s segment through the UpdateCustomerSegment API:

Field	Description
customer	ID (Ref ID / External ID) of the Customer.
customerSegment	New Segment of the Customer. Customer Segment must be configured.

Field

Description

customer

ID (Ref ID / External ID) of the Customer.

customerSegment

New Segment of the Customer. Customer Segment must be configured.

Detailed API documentation and endpoint specifics are available here.

Request Validations

The following validations are performed when updating a customer’s segment:

Customer must be provided in the request, it must be already created in the system and must not be in Deactivated State.

Update Customer’s Segment Example

Use the following request’s body to update a customer’s segment:

{
  "requestId": "{{$guid}}",
  "customer": {
    "externalId": "customer_external_id"
  },
  "customerSegment": "new_customer_segment_code"
}

The outcome of the API call is as follows:

The segment of the customer with external ID customer_external_id is updated to configured segment with code new_customer_segment_code.