audience

konigle.managers.comm.audience

Audience managers for the Konigle SDK.

This module provides managers for audience resources, enabling audience segment management operations including CRUD operations.

AsyncAudienceManager

Bases: BaseAudienceManager, BaseAsyncManager

Asynchronous manager for audience resources.

create(data) async

Create a new audience.

PARAMETER	DESCRIPTION
data	Audience creation data including all required fields TYPE: AudienceCreate

RETURNS	DESCRIPTION
Audience	Created audience instance with Active Record capabilities

Example

from konigle.models.comm import AudienceCreate

audience_data = AudienceCreate(
    name="Newsletter Subscribers",
    code="newsletter-subscribers",
    description="All contacts who subscribed to newsletter",
    tags=["newsletter", "engaged"],
)
audience = await client.audiences.create(audience_data)
print(f"Created audience: {audience.name}")

AudienceManager

Bases: BaseAudienceManager, BaseSyncManager

Synchronous manager for audience resources.

create(data)

Create a new audience.

PARAMETER	DESCRIPTION
data	Audience creation data including all required fields TYPE: AudienceCreate

RETURNS	DESCRIPTION
Audience	Created audience instance with Active Record capabilities

Example

from konigle.models.comm import AudienceCreate

audience_data = AudienceCreate(
    name="Newsletter Subscribers",
    code="newsletter-subscribers",
    description="All contacts who subscribed to newsletter",
    tags=["newsletter", "engaged"],
)
audience = client.audiences.create(audience_data)
print(f"Created audience: {audience.name}")

BaseAudienceManager

Base class for audience managers with shared configuration.

base_path = '/reachout/api/v1/audiences' class-attribute instance-attribute

The API base path for this resource type.

filter_class = AudienceFilters class-attribute instance-attribute

The filter model class for this resource type.

resource_class = Audience class-attribute instance-attribute

The resource model class this manager handles.

resource_update_class = AudienceUpdate class-attribute instance-attribute

The model class used for updating resources.