CampaignFlow.Client.Referrals (CampaignFlow Client v2.0.0)

View Source

Referral resource operations for the Campaign Flow API.

Summary

Functions

Submits a new referral.

Retrieves a specific referral by ID.

Lists all referrals.

Functions

create(client, params)

Submits a new referral.

Examples

{:ok, referral} = CampaignFlow.Client.Referrals.create(client, %{
  name: "John Doe",
  email: "john@example.com"
})

get(client, id)

Retrieves a specific referral by ID.

Examples

{:ok, referral} = CampaignFlow.Client.Referrals.get(client, 123)

list(client, params \\ [])

Lists all referrals.

Options

  • :page - Page number for pagination
  • :per_page - Number of items per page

Examples

{:ok, referrals} = CampaignFlow.Client.Referrals.list(client)