exgrid v1.0.0 ExGrid.Blocks

Manage blocks

Link to this section Summary

Functions

get block count

get all blocks

get blocks with optional parameters

Link to this section Functions

Link to this function count(credentials)

get block count

Link to this function get(credentials)

get all blocks

Link to this function get(credentials, sdate)

get blocks with optional parameters

  • see sendgrid api docs

  • note for start_date and end_date they must be in YYYY-M-D string format

Examples:

iex> ExGrid.Blocks.get(credentials, %{start_date: “2014-7-10”, end_date: “2014-7-20”})

iex> ExGrid.Blocks.get(credentials, %{date: “1”})

iex> ExGrid.Blocks.get(credentials, %{date: 1, limit: 1})

Link to this function remove(credentials, parameters)

Remove a block

  • Only parameter accepted is email

Example

iex> ExGrid.Blocks.remove(credentials, %{email: “foobar@baz.com”})