Subscriber Management

This chapter provides a comprehensive guide to managing subscribers within the OCS.io. It covers various aspects of subscriber management, including creating, updating, and retrieving subscriber information. The following sub-chapters are included:

The CreateSubscriber API allows for the creation of new subscribers within the system. This API provides the necessary functionality to set up subscriber details and initial configurations.

The CreateSubscriptionOnSubscriber API covers the management of subscriptions related to subscribers. This includes recording, updating, and retrieving subscription details to maintain accurate records.

The UpdateSubscriberExternalId API allows for the modification of a subscriber’s external ID. This API provides the necessary functionality to update the external identifier used for subscriber management.

The UpdateSubscriberCustomName API covers the management of custom names associated with subscribers. This includes updating the custom name to reflect changes in subscriber details.

The UpdateSubscriberCustomAttributes API enables the modification of custom attributes for a subscriber. Custom attributes are implemented as key-value pairs, and the system must provide the full set of key-value pairs in the request.

The UpdateSubscriberSegment API allows for updating the segment of a subscriber. This attribute is used for categorizing subscribers and is crucial for subsequent processes.

The UpdateSubscriberState API provides the functionality to change the state of a subscriber. This includes updating the subscriber’s status to active, inactive, or other states as required.

The CreateSubscriberResource API enables the addition of resources to an existing subscriber. This includes assigning specific resources that the subscriber will use.

The SwapSubscriberResource API enables the swapping of resources for a subscriber. This is useful for updating or changing the resources assigned to a subscriber.

The ReadSubscriberResource API provides access to the resources associated with a subscriber. This includes retrieving information about the resources assigned to a subscriber.

The ReadSubscriber API allows for retrieving detailed information about a subscriber using their unique identifier. This API is essential for accessing subscriber data for management and reporting purposes.

Each sub-chapter provides detailed information on the respective API, including usage examples, parameters, and expected responses. This guide aims to equip developers with the knowledge and tools necessary to effectively manage subscribers within the OCS.io.