CampaignFlow.Client.Signatories (CampaignFlow Client v2.0.0)

View Source

Signatory resource operations for the Campaign Flow API.

Summary

Functions

Adds a new signatory.

Deletes a signatory.

Retrieves a specific signatory by ID.

Lists all signatories.

Updates an existing signatory.

Functions

create(client, params)

Adds a new signatory.

Examples

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

delete(client, id)

Deletes a signatory.

Examples

{:ok, response} = CampaignFlow.Client.Signatories.delete(client, 123)

get(client, id)

Retrieves a specific signatory by ID.

Examples

{:ok, signatory} = CampaignFlow.Client.Signatories.get(client, 123)

list(client, params \\ [])

Lists all signatories.

Options

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

Examples

{:ok, signatories} = CampaignFlow.Client.Signatories.list(client)

update(client, id, params)

Updates an existing signatory.

Examples

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