Audiences
An [Audience](/concepts/audiences) represents a user segment. Use the Audiences API to sync user segments from your data warehouse to Knock. Audiences can be used to target messages or orchestrate workflows via branch and step conditions. They can also be used as the recipient of a [Broadcast](/concepts/broadcasts).
Audiences
#Add members
#Adds one or more members to the specified audience.
Endpoint
Rate limit
Tier 3Path parameters
The key of the audience.
Request body
A list of audience members to add. Limited to 1,000 members per request.
The unique identifier for the tenant.
Returns
List members
#Returns a paginated list of members for the specified audience.
Endpoint
Rate limit
Tier 4Path parameters
The key of the audience.
Returns
A paginated list of audience members.
A list of audience members.
The typename of the schema.
Timestamp when the resource was created.
The unique identifier for the tenant.
A User represents an individual in your system who can receive notifications through Knock. Users are the most common recipients of notifications and are always referenced by your internal identifier.
The typename of the schema.
A URL for the avatar of the user.
The creation date of the user from your system.
The primary email address for the user.
The unique identifier of the user.
Display name of the user.
The E.164 phone number of the user (required for SMS channels).
The timezone of the user. Must be a valid tz database time zone string. Used for recurring schedules.
The timestamp when the resource was last updated.
The unique identifier of the user.
Pagination information for a list of resources.
The typename of the schema.
The cursor to fetch entries after.
The cursor to fetch entries before.
The number of items per page (defaults to 50).
Remove members
#Removes one or more members from the specified audience.
Endpoint
Rate limit
Tier 3Path parameters
The key of the audience.
Request body
A list of audience members to remove.
The unique identifier for the tenant.
Returns
AudienceMember
#An audience member.
Attributes
The typename of the schema.
Timestamp when the resource was created.
The unique identifier for the tenant.
A User represents an individual in your system who can receive notifications through Knock. Users are the most common recipients of notifications and are always referenced by your internal identifier.
The typename of the schema.
A URL for the avatar of the user.
The creation date of the user from your system.
The primary email address for the user.
The unique identifier of the user.
Display name of the user.
The E.164 phone number of the user (required for SMS channels).
The timezone of the user. Must be a valid tz database time zone string. Used for recurring schedules.
The timestamp when the resource was last updated.
The unique identifier of the user.