audience
konigle.models.comm.audience
¶
Audience models for the Konigle SDK.
Contact segment definitions based on tags for campaign targeting. Audiences allow grouping contacts by tags for targeted marketing campaigns.
Audience
¶
Bases: BaseAudience, TimestampedResource
Contact segment definition based on tags for campaign targeting.
Audiences enable marketers to create targeted segments of contacts based on tags for use in email campaigns and other marketing activities.
code = Field(title='Audience Code', description='Unique code for the audience (slug format).', max_length=100, pattern='^[a-z0-9]+(?:-[a-z0-9]+)*$')
class-attribute
instance-attribute
¶
Unique code for the audience.
AudienceCreate
¶
Bases: BaseAudience, CreateModel
Model for creating a new audience.
code = Field(default=None, title='Audience Code', description='Unique code for the audience (slug format).', max_length=100, pattern='^[a-z0-9]+(?:-[a-z0-9]+)*$')
class-attribute
instance-attribute
¶
Unique code for the audience. If not provided, it will be auto-generated based on the name.
AudienceUpdate
¶
Bases: UpdateModel
Model for updating an existing audience.
code = Field(default=None, title='Audience Code', description='Unique code for the audience (slug format).', max_length=100, pattern='^[a-z0-9]+(?:-[a-z0-9]+)*$')
class-attribute
instance-attribute
¶
Unique code for the audience.
description = Field(default=None, title='Description', description='Description of the audience segment.')
class-attribute
instance-attribute
¶
Description of the audience segment.
name = Field(default=None, title='Audience Name', description='Name of the audience segment.', max_length=255)
class-attribute
instance-attribute
¶
Name of the audience segment.
tags = Field(default=None, title='Tags', description='Tags to filter contacts for this audience.')
class-attribute
instance-attribute
¶
Tags to filter contacts for this audience.
BaseAudience
¶
Bases: BaseModel
Base audience model with shared fields.
description = Field(default='', title='Description', description='Description of the audience segment.')
class-attribute
instance-attribute
¶
Description of the audience segment.
name = Field(title='Audience Name', description='Name of the audience segment.', max_length=255)
class-attribute
instance-attribute
¶
Name of the audience segment.
tags = Field(title='Tags', description='Tags to filter contacts for this audience.')
class-attribute
instance-attribute
¶
Tags to filter contacts for this audience.