CampaignFlow.Client.Users (CampaignFlow Client v2.0.0)

View Source

User resource operations for the Campaign Flow API.

Summary

Functions

Creates a new user.

Retrieves a specific user by ID.

Lists all users.

Updates an existing user.

Functions

create(client, params)

Creates a new user.

Examples

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

get(client, id)

Retrieves a specific user by ID.

Examples

{:ok, user} = CampaignFlow.Client.Users.get(client, 123)

list(client, params \\ [])

Lists all users.

Options

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

Examples

{:ok, users} = CampaignFlow.Client.Users.list(client)
{:ok, users} = CampaignFlow.Client.Users.list(client, page: 2)

update(client, id, params)

Updates an existing user.

Examples

{:ok, user} = CampaignFlow.Client.Users.update(client, 123, %{
  name: "Jane Doe"
})