Sendio.Audiences (sendio v1.1.0)

Manage audiences in Sendio.

Deprecation Notice

Audiences are deprecated in favor of Segments. The API documentation notes: "Audiences are now called Segments. Follow the Migration Guide."

These endpoints still function, and an audience_id is required for filtering Contacts, Segments, and Topics by audience. However, consider using Segments for new implementations.

Summary

Functions

create(client \\ Sendio.client(), opts)

Creates a new audience.

get(client \\ Sendio.client(), audience_id)

Gets an audience by ID.

list(client \\ Sendio.client())

Lists all audiences.

remove(client \\ Sendio.client(), audience_id)

Removes an audience.

Functions

Link to this function

create(client \\ Sendio.client(), opts)

@spec create(Sendio.Client.t(), Keyword.t()) ::
  Sendio.Client.response(Sendio.Audiences.Audience.t())

Creates a new audience.

Options

  • :name - The name of the audience (required)
Link to this function

get(client \\ Sendio.client(), audience_id)

@spec get(Sendio.Client.t(), String.t()) ::
  Sendio.Client.response(Sendio.Audiences.Audience.t())

Gets an audience by ID.

Link to this function

list(client \\ Sendio.client())

@spec list(Sendio.Client.t()) ::
  Sendio.Client.response(Sendio.List.t(Sendio.Audiences.Audience.t()))

Lists all audiences.

Link to this function

remove(client \\ Sendio.client(), audience_id)

@spec remove(Sendio.Client.t(), String.t()) ::
  Sendio.Client.response(Sendio.Empty.t())

Removes an audience.