Accounts

User Account

Get /account(Click here to show example)
Response
account_id Integer
email String
first_name String
last_name String
timezone String
avatar_url String
joined_at String
last_seen_at String or Null

Broadcasts

List Broadcasts

Get /broadcasts(Click here to show example)
Query String Parameters
per_page Integer
page Integer
keyword String
sort String asc, desc
search_by String name, status
order_by String name, created_at
Response
broadcast_id Integer
name String
recipients Array[object]
show properties
match String
conditions Array[object]
show properties
type String
operator String
value String or Integer
email Object
show properties
subject String
body String
sender Object
show properties
email String
name String
company String
address String
footer String
schedule Object
show properties
type String
datetime String
timezone String
stats Object
show properties
sent Number
opens Number
clicks Number
altv Number
bounces Number
spams Number
unsubscribes Number
sent_at String or Null
created_at String

Get Broadcast

Get /broadcasts/{broadcast_id}(Click here to show example)
Response
broadcast_id Integer
name String
recipients Array[object]
show properties
match String
conditions Array[object]
show properties
type String
operator String
value String or Integer
email Object
show properties
subject String
body String
sender Object
show properties
email String
name String
company String
address String
footer String
schedule Object
show properties
type String
datetime String
timezone String
stats Object
show properties
sent Number
opens Number
clicks Number
altv Number
bounces Number
spams Number
unsubscribes Number
sent_at String or Null
created_at String

Create Broadcast

Post /broadcasts(Click here to show example)
Request Body
name String required
recipients Array[object]
show properties
match String any, all, exclude
conditions Array[object]
show properties
type String required tag, sequence, segment
operator String required equal, not_equal
value String or Integer required
email Object required
show properties
subject String required
body String required
sender Object
show properties
email String required
name String required
company String
address String required
footer String
schedule Object required
show properties
type String required
datetime String
timezone String
Response
broadcast_id Integer
name String
recipients Array[object]
show properties
match String
conditions Array[object]
show properties
type String
operator String
value String or Integer
email Object
show properties
subject String
body String
sender Object
show properties
email String
name String
company String
address String
footer String
schedule Object
show properties
type String
datetime String
timezone String
stats Object
show properties
sent Number
opens Number
clicks Number
altv Number
bounces Number
spams Number
unsubscribes Number
sent_at String or Null
created_at String

Update Broadcast

Patch /broadcasts/{broadcast_id}(Click here to show example)
Request Body
name String required
recipients Array[object]
show properties
match String any, all, exclude
conditions Array[object]
show properties
type String required tag, sequence, segment
operator String required equal, not_equal
value String or Integer required
email Object required
show properties
subject String required
body String required
sender Object
show properties
email String required
name String required
company String
address String required
footer String
schedule Object required
show properties
type String required
datetime String
timezone String
Response
broadcast_id Integer
name String
recipients Array[object]
show properties
match String
conditions Array[object]
show properties
type String
operator String
value String or Integer
email Object
show properties
subject String
body String
sender Object
show properties
email String
name String
company String
address String
footer String
schedule Object
show properties
type String
datetime String
timezone String
stats Object
show properties
sent Number
opens Number
clicks Number
altv Number
bounces Number
spams Number
unsubscribes Number
sent_at String or Null
created_at String

Contacts

List contacts

Get /contacts(Click here to show example)
Query String Parameters
per_page Integer
page Integer
keyword String
sort String asc, desc
search_by String name, email, sequence, tag
order_by String name, email, confirmed_at, subscribed_at
Response
contact_id Integer
email String
fields Object
show properties
first_name String
last_name String
{key} String
ipaddress String
tags Object
show properties
tag_id Integer
name String
tagged_at String
sequences Object
show properties
sequence_id Integer
current_step Number
name String
description String
subscribed_at String
confirmed_at String
subscribed_at String
confirmed_at String

Get Contact

Get /contacts/{contact_id}(Click here to show example)
Response
contact_id Integer
email String
fields Array[object]
show properties
first_name String
last_name String
{key} String
ipaddress String
tags Array[object]
show properties
tag_id Integer
name String
tagged_at String
sequences Object
show properties
sequence_id Integer
current_step Number
name String
description String
subscribed_at String
confirmed_at String
subscribed_at String
confirmed_at String

Create Contact

Post /contacts(Click here to show example)
Request Body
email String required
fields Object
show properties
first_name String
last_name String
{key} String
form_id Integer required
ipaddress String ipv4
Response
contact_id Integer
email String
fields Array[object]
show properties
first_name String
last_name String
{key} String
tags Array[object]
show properties
tag_id Integer
name String
tagged_at String
sequences Object
show properties
sequence_id Integer
current_step Number
name String
description String
subscribed_at String
confirmed_at String
subscribed_at String
confirmed_at String

Update Contact

Patch /contacts/{contact_id}(Click here to show example)
Request Body
email String required
fields Object
show properties
first_name String
last_name String
{key} String
ipaddress String ipv4
Response
contact_id Integer
email String
fields Array[object]
show properties
first_name String
last_name String
{key} String
tags Array[object]
show properties
tag_id Integer
name String
tagged_at String
sequences Object
show properties
sequence_id Integer
current_step Number
name String
description String
subscribed_at String
confirmed_at String
subscribed_at String
confirmed_at String

Add Tag(s)

Post /contacts/{contact_id}/tags(Click here to show example)

Assign tag(s) to an existing contact.

Request Body
tags Array[string] required
Response
contact_id Integer
email String
fields Array[object]
show properties
first_name String
last_name String
{key} String
tags Array[object]
show properties
tag_id Integer
name String
tagged_at String
sequences Object
show properties
sequence_id Integer
current_step Number
name String
description String
subscribed_at String
confirmed_at String
subscribed_at String
confirmed_at String

Remove Tag(s)

Delete /contacts/{contact_id}/tags/{tag_id}(Click here to show example)

Remove a tag from a contact.

Response

Subscribe To Form

Post /contacts/{contact_id}/subscribe(Click here to show example)

Subscribe your contact to a form.

Request Body
form_id Integer required
fields Object
show properties
first_name String
last_name String
{key} String
ipaddress String ipv4
Response
contact_id Integer
email String
fields Array[object]
show properties
first_name String
last_name String
{key} String
tags Array[object]
show properties
tag_id Integer
name String
tagged_at String
sequences Object
show properties
sequence_id Integer
current_step Number
name String
description String
subscribed_at String
confirmed_at String
subscribed_at String
confirmed_at String

Unsubscribe

Delete /contacts/{contact_id}/unsubscribe(Click here to show example)

Unsubscribe your contact from all mailings.

Response

Custom Fields

List Custom Fields

Get /fields(Click here to show example)
Query String Parameters
per_page Integer
page Integer
keyword String
sort String asc, desc
search_by String label
order_by String label
Response
data Array[object] required
show properties
field_id Integer
label String
type String
key String
default String
links Object required
show properties
meta Object required
show properties
current_page Integer
total Integer
last_page Integer
per_page Integer
path String

Get Custom Field

Get /fields/{field_id}(Click here to show example)
Response
field_id Integer
label String
type String
key String
default String

Create Custom Field

Post /fields(Click here to show example)
Request Body
label String required
type String required text, textarea
key String required
default String
Response
field_id Integer
label String
type String
key String
default String

Delete Custom Field

Delete /fields/{field_id}(Click here to show example)

Delete a custom field.

Response

A successful request returns the HTTP 204 status code and an empty response body.

Forms

Manage your BirdSend forms.

List Forms

Get /forms(Click here to show example)

List your forms.

Query String Parameters
per_page Integer
page Integer
keyword String
sort String asc, desc
search_by String name
order_by String name, created_by
Response

A successful request returns the HTTP 200 status code and a JSON response body that shows list of forms.

data Array[object] required
show properties
form_id Integer
name String
links Object required
show properties
meta Object required
show properties
current_page Integer
total Integer
last_page Integer
per_page Integer
path String

Get Form

Get /forms/{form_id}(Click here to show example)
Request Body
label String required
type String required text, textarea
key String required
default String
Response
form_id Integer
name String

Pixels

Get Pixel Code

Get /pixels/code(Click here to show example)
Response
code String

Rules

List Rules

Get /rules(Click here to show example)
Query String Parameters
per_page Integer
page Integer
keyword String
sort String asc, desc
search_by String name
order_by String name, created_at
Response
data Array[object] required
show properties
rule_id Integer
name String
active Boolean
triggers Array[object]
show properties
trigger String
params Object
show properties
{param_name} String or Number
actions Array[object]
show properties
action String
params Object
show properties
{param_name} String or Number
created_at String
last_run_at String
links Object required
show properties
meta Object required
show properties
current_page Integer
total Integer
last_page Integer
per_page Integer
path String

Get Rule

Get /rules/{rule_id}(Click here to show example)
Response
rule_id Integer
name String
active Boolean
triggers Array[object]
show properties
trigger String
params Object
show properties
{param_name} String or Number
actions Array[object]
show properties
action String
params Object
show properties
{param_name} String or Number
created_at String
last_run_at String

Create Rule

Post /rules(Click here to show example)
Request Body
name String required
active Boolean required
triggers Array[object]
show properties
trigger String required tag_applied, tag_removed, email_opened, link_clicked, subscribed, unsubscribed, sequence_completed, has_conversion, has_conversion_value
params Object required
trigger params
tag_applied, tag_removed tag: String
has_conversion, has_conversion_value operator: exceeds, equals
value: Number
subscribed, unsubscribed, sequence_completed sequence_id: Integer
email_opened type: any, sequence, broadcast
sequence_id: Integer *required if type is "sequence"
email_id: Integer *required if type is "sequence", can have value "any"
broadcast_id: Integer *required if type is "broadcast"
link_clicked type: any, sequence, broadcast
sequence_id: Integer *required if type is "sequence"
email_id: Integer *required if type is "sequence"
broadcast_id: Integer *required if type is "broadcast"
url: String
actions Array[object]
show properties
action String required apply_tag, remove_tag, subscribe, unsubscribe, move_sequence, add_conversion, delete
params Object required
trigger params
apply_tag, remove_tag tag: String
subscribe, unsubscribe sequence_id: Integer
move_sequence from_sequence_id: Integer
to_sequence_id: Integer
add_conversion, delete *Not required
Response
rule_id Integer
name String
active Boolean
triggers Array[object]
show properties
trigger String
params Object
show properties
{param_name} String or Number
actions Array[object]
show properties
action String
params Object
show properties
{param_name} String or Number
created_at String
last_run_at String

Update Rule

Patch /rules/{rule_id}(Click here to show example)
Request Body
name String
active Boolean
triggers Array[object]
show properties
trigger String required tag_applied, tag_removed, email_opened, link_clicked, subscribed, unsubscribed, sequence_completed, has_conversion, has_conversion_value
params Object required
trigger params
tag_applied, tag_removed tag: String
has_conversion, has_conversion_value operator: exceeds, equals
value: Number
subscribed, unsubscribed, sequence_completed sequence_id: Integer
email_opened type: any, sequence, broadcast
sequence_id: Integer *required if type is "sequence"
email_id: Integer *required if type is "sequence", can have value "any"
broadcast_id: Integer *required if type is "broadcast"
link_clicked type: any, sequence, broadcast
sequence_id: Integer *required if type is "sequence"
email_id: Integer *required if type is "sequence"
broadcast_id: Integer *required if type is "broadcast"
url: String
actions Array[object]
show properties
action String required apply_tag, remove_tag, subscribe, unsubscribe, move_sequence, add_conversion, delete
params Object required
trigger params
apply_tag, remove_tag tag: String
subscribe, unsubscribe sequence_id: Integer
move_sequence from_sequence_id: Integer
to_sequence_id: Integer
add_conversion, delete *Not required
Response
rule_id Integer
name String
active Boolean
triggers Array[object]
show properties
trigger String
params Object
show properties
{param_name} String or Number
actions Array[object]
show properties
action String
params Object
show properties
{param_name} String or Number
created_at String
last_run_at String

Sequences

List Sequences

Get /sequences(Click here to show example)
Query String Parameters
per_page Integer
page Integer
keyword String
sort String asc, desc
search_by String name, active
order_by String name, active, created_at
Response
data Array[object] required
show properties
sequence_id Integer
name String
description String
sender Object
show properties
email String
name String
company String
address String
footer String
notification String
active String
created_at String
links Object required
show properties
meta Object required
show properties
current_page Integer
total Integer
last_page Integer
per_page Integer
path String

Get Sequence

Get /sequences/{sequence_id}(Click here to show example)
Response
sequence_id Integer
name String
description String
sender Object
show properties
email String
name String
company String
address String
footer String
notification String
active String
created_at String

Create Sequence

Post /sequences(Click here to show example)
Request Body
name String required
description String
sender Object required
show properties
email String required
name String required
company String
address String required
footer String
notification String
Response
sequence_id Integer
name String
description String
sender Object
show properties
email String
name String
company String
address String
footer String
notification String
active String
created_at String

Update Sequence

Patch /sequences/{sequence_id}(Click here to show example)
Request Body
name String required
description String
sender Object required
show properties
email String required
name String required
company String
address String required
footer String
notification String
active Boolean
Response
sequence_id Integer
name String
description String
sender Object
show properties
email String
name String
company String
address String
footer String
notification String
active String
created_at String

List Sequence Emails

Get /sequences/{sequence_id}/emails(Click here to show example)
Query String Parameters
per_page Integer
page Integer
keyword String
sort String asc, desc
search_by String subject, active
order_by String subject, active
Response
data Array[object] required
show properties
email_id Integer
sequence_id Integer
subject String
body String
schedule Object
show properties
delay Number
type String
active Boolean
stats Object
show properties
sent Number
opens Number
clicks Number
altv Number
bounces Number
spams Number
unsubscribes Number
order Number
links Object required
show properties
meta Object required
show properties
current_page Integer
total Integer
last_page Integer
per_page Integer
path String

Get Sequence Email

Get /sequences/{sequence_id}/emails/{email_id}(Click here to show example)
Response
email_id Integer
sequence_id Integer
subject String
body String
schedule Object
show properties
delay Number
type String
active Boolean
stats Object
show properties
sent Number
opens Number
clicks Number
altv Number
bounces Number
spams Number
unsubscribes Number
order Number

Create Sequence Email

Post /sequences/{sequence_id}/emails(Click here to show example)
Request Body
subject String required
body String required
schedule Object
show properties
delay Number required
type String required
active Boolean
Response
email_id Integer
sequence_id Integer
subject String
body String
schedule Object
show properties
delay Number
type String
active Boolean
stats Object
show properties
sent Number
opens Number
clicks Number
altv Number
bounces Number
spams Number
unsubscribes Number
order Number

Update Sequence Email

Patch /sequences/{sequence_id}/emails/{email_id}(Click here to show example)
Request Body
subject String required
body String required
schedule Object
show properties
delay Number required
type String required
active Boolean
Response
email_id Integer
sequence_id Integer
subject String
body String
schedule Object
show properties
delay Number
type String
active Boolean
stats Object
show properties
sent Number
opens Number
clicks Number
altv Number
bounces Number
spams Number
unsubscribes Number
order Number

Tags

List Tags

Get /tags(Click here to show example)
Query String Parameters
per_page Integer
page Integer
keyword String
sort String asc, desc
search_by String name
order_by String name
Response
data Array[object] required
show properties
tag_id Integer
name String
links Object required
show properties
meta Object required
show properties
current_page Integer
total Integer
last_page Integer
per_page Integer
path String

Get Tag

Get /tags/{tag_id}(Click here to show example)
Response
tag_id Integer
name String

Create Tag

Post /tags(Click here to show example)
Request Body
name String required
Response
tag_id Integer
name String

Update Tag

Patch /tags/{tag_id}(Click here to show example)
Request Body
name String
Response
tag_id Integer
name String
Definition

Get | https://api.birdsend.co/v1/account

Response Example

200


{
  "account_id": 6932,
  "email": "johndoe@example.com",
  "first_name": "John",
  "last_name": "Doe",
  "timezone": "America/New_York",
  "avatar_url": "",
  "joined_at": "2015-09-20 15:26:34",
  "last_seen_at": "2016-10-12 12:04:26"
}


Definition

Get | https://api.birdsend.co/v1/broadcasts

Response Example

200


{
  "data": [
    {
      "broadcast_id": 5691,
      "name": "First Broadcast",
      "email": {
        "subject": "Please open this",
        "body": "<p>Hello,</p><p>This is my <strong>first email</strong> broadcast</p><p>Talk soon,<br>John Doe</p>"
      },
      "immediate": false,
      "stats": {
        "altv": 0,
        "clicks": 12,
        "spams": 0,
        "bounces": 2,
        "sent": 100,
        "opens": 20,
        "unsubscribes": 2
      },
      "schedule": "2018-05-11 22:00:00",
      "footer": "<p>Connect with me on social sites</p>",
      "recipients": [
        {
          "match": "any",
          "conditions": [
            {
              "type": "tag",
              "operator": "not_equal",
              "value": 45
            },
            {
              "type": "sequence",
              "value": 30
            }
          ]
        }
      ],
      "sender": {
        "email": "johndoe@example.com",
        "name": "John Doe",
        "address": "3566 Linda Street, Philadelphia, PA 19103, USA"
      },
      "sent_at": "2018-05-11 22:00:00",
      "created_at": "2018-05-10 09:34:21"
    },
    {
      "broadcast_id": 6634,
      "name": "Second Broadcast",
      "email": {
        "subject": "Please open this again",
        "body": "<p>Hello,</p><p>This is my <strong>first email</strong> broadcast</p><p>Talk soon,<br>John Doe</p>"
      },
      "immediate": true,
      "stats": {
        "altv": 0,
        "clicks": 12,
        "spams": 0,
        "bounces": 2,
        "sent": 100,
        "opens": 20,
        "unsubscribes": 2
      },
      "schedule": "2018-07-31 19:15:01",
      "footer": "<p>Connect with me on social sites</p>",
      "recipients": [
        {
          "match": "any",
          "conditions": [
            {
              "type": "sequence",
              "operator": "not_equal",
              "value": 21
            }
          ]
        }
      ],
      "sender": {
        "email": "johndoe@example.com",
        "name": "John Doe",
        "address": "3566 Linda Street, Philadelphia, PA 19103, USA"
      },
      "sent_at": null,
      "created_at": "2018-07-31 19:14:54"
    }
  ],
  "links": {
    "first": "https://api.birdsend.co/ver/broadcasts?page=2",
    "last": "https://api.birdsend.co/ver/broadcasts?page=10",
    "prev": "https://api.birdsend.co/ver/broadcasts?page=1",
    "next": "https://api.birdsend.co/ver/broadcasts?page=3"
  },
  "meta": {
    "current_page": 2,
    "total": 23,
    "last_page": 12,
    "per_page": 2,
    "path": "https://api.birdsend.co/ver/broadcasts"
  }
}


Definition

Get | https://api.birdsend.co/v1/broadcasts/{broadcast_id}

Response Example

200


{
  "broadcast_id": 5691,
  "name": "First Broadcast",
  "email": {
    "subject": "Please open this",
    "body": "<p>Hello,</p><p>This is my <strong>first email</strong>broadcast</p><p>Talk soon,<br>John Doe</p>"
  },
  "immediate": false,
  "stats": {
    "altv": 0,
    "clicks": 12,
    "spams": 0,
    "bounces": 2,
    "sent": 100,
    "opens": 20,
    "unsubscribes": 2
  },
  "schedule": "2018-05-11 22:00:00",
  "footer": "<p>Connect with me on social sites</p>",
  "recipients": [
    {
      "match": "any",
      "conditions": [
        {
          "type": "tag",
          "operator": "equal",
          "value": 675
        },
        {
          "type": "sequence",
          "operator": "equal",
          "value": 370
        }
      ]
    }
  ],
  "sender": {
    "email": "johndoe@example.com",
    "name": "John Doe",
    "company": "Whatever, inc.",
    "address": "3566 Linda Street, Philadelphia, PA 19103, USA"
  },
  "sent_at": "2018-05-11 22:00:00",
  "created_at": "2018-05-10 12:34:07"
}


Definition

Post | https://api.birdsend.co/v1/broadcasts

Request Body Example


{
  "name": "New Broadcast",
  "email": {
    "subject": "Don't forget to open this at night",
    "body": "<p>Hello,</p><p>This is my <strong>first email</strong>broadcast</p><p>Talk soon,<br>John Doe</p>"
  },
  "immediate": true,
  "footer": "<p>Connect with me on social sites</p>",
  "recipients": [
    {
      "match": "all",
      "conditions": [
        {
          "type": "tag",
          "operator": "equal",
          "value": 675
        },
        {
          "type": "sequence",
          "operator": "equal",
          "value": 370
        }
      ]
    }
  ],
  "sender": {
    "email": "johndoe@example.com",
    "name": "John Doe",
    "address": "3566 Linda Street, Philadelphia, PA 19103, USA"
  }
}


Response Example

201


{
  "name": "New Broadcast",
  "email": {
    "subject": "Don't forget to open this at night",
    "body": "<p>Hello,</p><p>This is my <strong>first email</strong>broadcast</p><p>Talk soon,<br>John Doe</p>"
  },
  "immediate": true,
  "stats": {
    "altv": 0,
    "clicks": 0,
    "spams": 0,
    "bounces": 0,
    "sent": 0,
    "opens": 0,
    "unsubscribes": 0
  },
  "footer": "<p>Connect with me on social sites</p>",
  "recipients": [
    {
      "match": "all",
      "conditions": [
        {
          "type": "tag",
          "operator": "equal",
          "value": 675
        },
        {
          "type": "sequence",
          "operator": "equal",
          "value": 370
        }
      ]
    }
  ],
  "sender": {
    "email": "johndoe@example.com",
    "name": "John Doe",
    "address": "3566 Linda Street, Philadelphia, PA 19103, USA"
  }
}


Definition

Patch | https://api.birdsend.co/v1/broadcasts/{broadcast_id}

Request Body Example


{
  "name": "My Broadcast",
  "email": {
    "subject": "Don't forget to open this at night",
    "body": "<p>Hello,</p><p>This is my <strong>first email</strong>broadcast</p><p>Talk soon,<br>John Doe</p>"
  },
  "immediate": false,
  "schedule": "2018-05-12 22:43:00",
  "footer": "<p>Connect with me on social sites</p>",
  "recipients": [
    {
      "match": "any",
      "conditions": [
        {
          "type": "sequence",
          "operator": "equal",
          "value": 370
        }
      ]
    },
    {
      "match": "exclude",
      "conditions": [
        {
          "type": "sequence",
          "operator": "equal",
          "value": 372
        }
      ]
    }
  ],
  "sender": {
    "email": "johndoe@example.com",
    "name": "John Doe",
    "address": "3566 Linda Street, Philadelphia, PA 19103, USA"
  }
}


Response Example

200


{
  "broadcast_id": 6372,
  "name": "My Broadcast",
  "email": {
    "subject": "Don't forget to open this at night",
    "body": "<p>Hello,</p><p>This is my <strong>first email</strong>broadcast</p><p>Talk soon,<br>John Doe</p>"
  },
  "immediate": false,
  "stats": {
    "altv": 0,
    "clicks": 12,
    "spams": 0,
    "bounces": 2,
    "sent": 100,
    "opens": 20,
    "unsubscribes": 2
  },
  "schedule": "2018-05-12 22:43:00",
  "footer": "<p>Connect with me on social sites</p>",
  "recipients": [
    {
      "match": "any",
      "conditions": [
        {
          "type": "sequence",
          "operator": "equal",
          "value": 370
        }
      ]
    },
    {
      "match": "exclude",
      "conditions": [
        {
          "type": "sequence",
          "operator": "equal",
          "value": 372
        }
      ]
    }
  ],
  "sender": {
    "email": "johndoe@example.com",
    "name": "John Doe",
    "address": "3566 Linda Street, Philadelphia, PA 19103, USA"
  },
  "sent_at": null,
  "created_at": "2018-05-11 18:32:43"
}


Definition

Delete | https://api.birdsend.co/v1/broadcasts/{broadcast_id}

Response Example

204


---


Definition

Get | https://api.birdsend.co/v1/contacts

Response Example

200


{
  "data": [
    {
      "contact_id": 5,
      "email": "ferne89@example.com",
      "fields": {
        "first_name": "Raoul",
        "last_name": "Hodkiewicz"
      },
      "ipaddress": "192.168.10.100",
      "tags": [],
      "sequences": [],
      "created_at": "2018-01-17 07:04:07",
      "updated_at": "2018-01-17 07:04:07"
    },
    {
      "contact_id": 6,
      "email": "nitzsche.cory@example.net",
      "fields": {
        "first_name": "Erica",
        "last_name": "Kulas"
      },
      "ipaddress": "192.168.10.100",
      "tags": [
        {
          "tag_id": 2,
          "name": "Tag 1",
          "tagged_at": "2018-01-17 07:08:54"
        },
        {
          "tag_id": 3,
          "name": "Tag 2",
          "tagged_at": "2018-01-17 07:09:59"
        }
      ],
      "sequences": [
        {
          "sequence_id": 1,
          "current_step": 3,
          "name": "Football Lovers",
          "description": "People who love football",
          "subscribed_at": "2018-01-30 07:05:38",
          "confirmed_at": "2018-01-30 09:23:38"
        }
      ],
      "subscribed_at": "2018-01-17 07:04:07",
      "confirmed_at": "2018-01-17 07:08:54"
    }
  ],
  "links": {
    "first": "https://api.birdsend.co/v1/contacts?page=2",
    "last": "https://api.birdsend.co/v1/contacts?page=10",
    "prev": "https://api.birdsend.co/v1/contacts?page=1",
    "next": "https://api.birdsend.co/v1/contacts?page=3"
  },
  "meta": {
    "current_page": 1,
    "from": 16,
    "last_page": 1,
    "path": "https://api.birdsend.co/v1/contacts",
    "per_page": 15,
    "to": 30,
    "total": 15
  }
}


Definition

Get | https://api.birdsend.co/v1/contacts/{contact_id}

Response Example

200


{
  "contact_id": 6,
  "email": "nitzsche.cory@example.net",
  "fields": {
    "first_name": "Erica",
    "last_name": "Kulas"
  },
  "ipaddress": "192.168.10.100",
  "tags": [
    {
      "tag_id": 2,
      "name": "Tag 1",
      "tagged_at": "2018-01-17 07:08:54"
    },
    {
      "tag_id": 3,
      "name": "Tag 2",
      "tagged_at": "2018-01-17 07:09:59"
    }
  ],
  "sequences": [
    {
      "sequence_id": 1,
      "current_step": 2,
      "name": "Fooball Lovers",
      "description": "People who love football",
      "subscribed_at": "2018-01-30 07:05:38",
      "confirmed_at": "2018-01-30 09:23:38"
    }
  ],
  "subscribed_at": "2018-01-17 07:04:07",
  "confirmed_at": "2018-01-17 07:08:54"
}


Definition

Post | https://api.birdsend.co/v1/contacts

Request Body Example


{
  "email": "david.martin@example.net",
  "fields": {
    "first_name": "David",
    "last_name": "Martin",
    "phone": "08765286542"
  },
  "ipaddress": "192.168.10.100"
}


Response Example

201


{
  "contact_id": 12,
  "email": "david.martin@example.net",
  "fields": {
    "first_name": "David",
    "last_name": "Martin",
    "phone": "08765286542"
  },
  "ipaddress": "192.168.10.100",
  "tags": [],
  "sequences": [],
  "subscribed_at": "2018-01-30 07:20:05",
  "confirmed_at": "2018-01-30 07:20:05"
}


Definition

Patch | https://api.birdsend.co/v1/contacts/{contact_id}

Request Body Example


{
  "email": "david.martinez@example.net",
  "fields": {
    "last_name": "Martinez"
  },
  "ipaddress": "192.168.10.100"
}


Response Example

200


{
  "contact_id": 12,
  "email": "david.martinez@example.net",
  "fields": {
    "first_name": "David",
    "last_name": "Martinez",
    "phone": "08765286542"
  },
  "ipaddress": "192.168.10.100",
  "tags": [],
  "sequences": [],
  "subscribed_at": "2018-01-30 07:20:05",
  "confirmed_at": "2018-01-30 07:25:37"
}


Definition

Delete | https://api.birdsend.co/v1/contacts/{contact_id}

Response Example

204


---


Definition

Post | https://api.birdsend.co/v1/contacts/{contact_id}/sequences

Request Body Example


{
  "sequence_id": 2
}


Response Example

201


{
  "contact_id": 12,
  "email": "david.martinez@example.net",
  "fields": {
    "first_name": "David",
    "last_name": "Martinez"
  },
  "tags": [],
  "sequences": [
    {
      "sequence_id": 2,
      "current_step": 0,
      "name": "Football Lovers",
      "description": "People who love football",
      "subscribed_at": "2018-01-30 07:34:28",
      "confirmed_at": "2018-01-30 09:23:28"
    }
  ],
  "subscribed_at": "2018-01-30 07:20:05",
  "confirmed_at": "2018-01-30 07:25:37"
}


Definition

Delete | https://api.birdsend.co/v1/contacts/{contact_id}/sequences/{sequence_id}

Response Example

204


---


Definition

Post | https://api.birdsend.co/v1/contacts/{contact_id}/tags

Request Body Example


{
  "tags": [
    "Special",
    "VIP"
  ]
}


Response Example

201


{
  "contact_id": 12,
  "email": "david.martinez@example.net",
  "fields": {
    "first_name": "David",
    "last_name": "Martinez"
  },
  "tags": [
    {
      "tag_id": 27,
      "name": "Special",
      "tagged_at": "2018-01-30 07:43:55"
    },
    {
      "tag_id": 28,
      "name": "VIP",
      "tagged_at": "2018-01-30 07:43:55"
    }
  ],
  "sequences": [
    {
      "sequence_id": 2,
      "current_step": 0,
      "name": "Football Lovers",
      "description": "People who love football",
      "subscribed_at": "2018-01-30 07:34:28",
      "confirmed_at": "2018-01-30 09:23:28"
    }
  ],
  "subscribed_at": "2018-01-30 07:20:05",
  "confirmed_at": "2018-01-30 07:25:37"
}


Definition

Delete | https://api.birdsend.co/v1/contacts/{contact_id}/tags/{tag_id}

Response Example

204


---


Definition

Post | https://api.birdsend.co/v1/contacts/{contact_id}/subscribe

Request Body Example


{
  "form_id": 2
}


Response Example

201


{
  "contact_id": 12,
  "email": "david.martinez@example.net",
  "fields": {
    "first_name": "David",
    "last_name": "Martinez"
  },
  "tags": [],
  "sequences": [
    {
      "sequence_id": 2,
      "current_step": 0,
      "name": "Football Lovers",
      "description": "People who love football",
      "subscribed_at": "2018-01-30 07:34:28",
      "confirmed_at": "2018-01-30 09:23:28"
    }
  ],
  "subscribed_at": "2018-01-30 07:20:05",
  "confirmed_at": "2018-01-30 07:25:37"
}


Definition

Delete | https://api.birdsend.co/v1/contacts/{contact_id}/unsubscribe

Response Example

204


---


Definition

Get | https://api.birdsend.co/v1/conversions

Response Example

200


---


Definition

Get | https://api.birdsend.co/v1//conversions/{id}

Response Example

200


---


Definition

Post | https://api.birdsend.co/v1//conversions

Response Example

201


---


Definition

Patch | https://api.birdsend.co/v1/conversions/{id}

Response Example

200


---


Definition

Delete | https://api.birdsend.co/v1/conversions/{id}

Response Example

204


---


Definition

Get | https://api.birdsend.co/v1/fields

Response Example

200


{
  "data": [
    {
      "field_id": 3,
      "label": "First Name",
      "type": "text",
      "key": "first_name",
      "default": ""
    },
    {
      "field_id": 4,
      "label": "Last Name",
      "type": "text",
      "key": "last_name",
      "default": ""
    }
  ],
  "links": {
    "first": "https://qatest.birdsend.co/v1/fields?page=2",
    "last": "https://qatest.birdsend.co/v1/fields?page=4",
    "prev": "https://qatest.birdsend.co/v1/fields?page=1",
    "next": "https://qatest.birdsend.co/v1/fields?page=3"
  },
  "meta": {
    "current_page": 1,
    "from": 16,
    "last_page": 1,
    "path": "https://qatest.birdsend.co/v1/fields",
    "per_page": 15,
    "to": 30,
    "total": 15
  }
}


Definition

Get | https://api.birdsend.co/v1/fields/{field_id}

Response Example

200


{
  "field_id": 3,
  "label": "First Name",
  "type": "text",
  "key": "first_name",
  "default": ""
}


Definition

Post | https://api.birdsend.co/v1/fields

Request Body Example


{
  "label": "gender",
  "type": "text",
  "key": "gender",
  "default": ""
}


Response Example

201


{
  "field_id": 6,
  "label": "gender",
  "type": "text",
  "key": "gender",
  "default": ""
}


Definition

Patch | https://api.birdsend.co/v1/fields/{field_id}

Request Body Example


{
  "label": "gender",
  "type": "text",
  "key": "gender",
  "default": "male"
}


Response Example

200


{
  "field_id": 6,
  "label": "gender",
  "type": "text",
  "key": "gender",
  "default": "male"
}


Definition

Delete | https://api.birdsend.co/v1/fields/{field_id}

Response Example

204


---


Definition

Get | https://api.birdsend.co/v1/forms

Response Example

200


{
  "data": [
    {
      "form_id": 2,
      "name": "Example Form 1"
    },
    {
      "form_id": 1,
      "name": "Example Form 2"
    }
  ],
  "links": {
    "first": "https://beats.dev/v1/forms?page=1",
    "last": "https://beats.dev/v1/forms?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://beats.dev/v1/forms",
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}


Definition

Get | https://api.birdsend.co/v1/forms/{form_id}

Response Example

200


{
  "form_id": 1,
  "name": "Example Form 1"
}


Definition

Get | https://api.birdsend.co/v1/pixels/code

Response Example

200


{
  "code": "<script>
    var _bsq = _bsq || [];
    _bsq.push(['init', '1']);
    _bsq.push(['track', 'PageView']);

    (function(w, d, s, id){
      var js, fjs = d.getElementsByTagName(s)[0];
      if (d.getElementById(id)) { return; }
      js = d.createElement(s); js.id = id;
      js.src = 'https://birdsend.app/pixel/script';
      fjs.parentNode.insertBefore(js, fjs);
    }(window, document, 'script', 'birdsend-pixel-js'));
  </script>"
}


Definition

Get | https://api.birdsend.co/v1/rules

Response Example

200


{
  "data": [
    {
      "rule_id": 1,
      "name": "SPF",
      "active": true,
      "triggers": [
        {
          "trigger": "subscribed",
          "params": {
            "sequence_id": 1
          }
        }
      ],
      "actions": [
        {
          "action": "unsubscribe",
          "params": {
            "sequence_id": 2
          }
        },
        {
          "action": "unsubscribe",
          "params": {
            "sequence_id": 2
          }
        }
      ],
      "created_at": "2018-02-01 03:32:11",
      "last_run_at": null
    }
  ],
  "links": {
    "first": "https://beats.dev/v1/rules?page=1",
    "last": "https://beats.dev/v1/rules?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://beats.dev/v1/rules",
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}


Definition

Get | https://api.birdsend.co/v1/rules/{rule_id}

Response Example

200


{
 "rule_id": 1,
 "name": "Auto apply VIP tag",
 "active": true,
 "triggers": [
   {
     "trigger": "subscribed",
     "params": {
       "sequence_id": 2
     }
   }
 ],
 "actions": [
   {
     "action": "apply_tag",
     "params": {
       "tag": [
         "VIP"
       ]
     }
   }
 ],
 "created_at": "2018-01-22 04:28:30",
 "last_run_at": null
}


Definition

Post | https://api.birdsend.co/v1/rules

Request Body Example


{
  "name": "minim",
  "active": true,
  "triggers": [
    {
      "trigger": "subscribed",
      "params": {
        "sequence_id": 1
      }
    }
  ],
  "actions": [
    {
      "action": "remove_tag",
      "params": {
        "tag": "Paid"
      }
    }
  ]
}


Response Example

201


{
  "rule_id": 3,
  "name": "minim",
  "active": true,
  "triggers": [
    {
      "trigger": "subscribed",
      "params": {
        "sequence_id": 1
      }
    }
  ],
  "actions": [
    {
      "action": "remove_tag",
      "params": {
        "tag": [
          "Paid"
        ]
      }
    }
  ],
  "created_at": "2018-02-01 08:41:32",
  "last_run_at": null
}


Definition

Patch | https://api.birdsend.co/v1/rules/{rule_id}

Request Body Example


{
  "name": "update rule",
  "active": false,
  "triggers": [
    {
      "trigger": "subscribed",
      "params": {
        "sequence_id": 1
      }
    }
  ],
  "actions": [
    {
      "action": "remove_tag",
      "params": {
        "tag": "Paid"
      }
    }
  ]
}


Response Example

200


{
  "rule_id": 1,
  "name": "update rule",
  "active": false,
  "triggers": [
    {
      "trigger": "subscribed",
      "params": {
        "sequence_id": 1
      }
    }
  ],
  "actions": [
    {
      "action": "remove_tag",
      "params": {
        "tag": [
          "Paid"
        ]
      }
    }
  ],
  "created_at": "2018-02-01 03:32:11",
  "last_run_at": null
}


Definition

Delete | https://api.birdsend.co/v1/rules/{rule_id}

Response Example

204


---


Definition

Get | https://api.birdsend.co/v1/sequences

Response Example

200


{
  "data": [
    {
      "sequence_id": 2,
      "name": "yahoo",
      "description": "",
      "sender": {
        "email": "john@zaxaa.com",
        "name": "John Doe",
        "address": "Nort Carolina St.104 Mount AA",
        "company": "BirdSend"
      },
      "footer": "<p>This email was sent to you (%contact.email%) because you opted in on our website and indicated you’d like to receive emails from us. If you no longer wish to receive such emails, please <a> href=\"%unsubscribelink%\" target=\"_blank\">unsubscribe here</a></p><p>To ensure you receive our emails, please add <strong>%sender.email%</strong> to your address book.</p><p>Our postal address: %sender.address%</p>",
      "notification": null,
      "active": null,
      "created_at": "2018-02-01 03:30:55"
    },
    {
      "sequence_id": 1,
      "name": "Bca",
      "description": "",
      "sender": {
        "email": "john@beatsmail.com",
        "name": "John Doe",
        "address": "Nort Carolina St.104 Mount AA",
        "company": "BirdSend"
      },
      "footer": "<p>This email was sent to you (%contact.email%) because you opted in on our website and indicated you’d like to receive emails from us. If you no longer wish to receive such emails, please <a href=\"%unsubscribelink%\" target=\"_blank\">unsubscribe here</a></p><p>To ensure you receive our emails, please add <strong>%sender.email%</strong> to your address book.</p><p>Our postal address: %sender.address%</p>",
      "notification": "",
      "active": null,
      "created_at": "2018-01-23 01:33:21"
    }
  ],
  "links": {
    "first": "https://beats.dev/v1/sequences?page=1",
    "last": "https://beats.dev/v1/sequences?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://beats.dev/v1/sequences",
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}


Definition

Get | https://api.birdsend.co/v1/sequences/{sequence_id}

Response Example

200


{
  "sequence_id": 95483,
  "name": "Freebie Sequence",
  "description": "",
  "sender": {
    "email": "johndoe@example.com",
    "name": "John Doe",
    "company": "Whatever, inc.",
    "address": "3566 Linda Street, Philadelphia, PA 19103, USA"
  },
  "footer": "<p>Connect with me at social sites:</p>",
  "notification": "johndoe@example.com",
  "active": true,
  "created_at": "2017-10-28 13:28:34"
}


Definition

Post | https://api.birdsend.co/v1/sequences

Request Body Example


{
  "name": "New Sequence",
  "description": "My new sequence",
  "sender": {
    "email": "john@beats.com",
    "name": "deserunt ex dolor proident",
    "company": "in",
    "address": "ut sit sint "
  },
  "footer": "this is footer",
  "notification": ""
}


Response Example

201


{
  "sequence_id": 3,
  "name": "New Sequence",
  "description": "",
  "sender": {
    "email": "john@beats.com",
    "name": "deserunt ex dolor proident",
    "address": "ut sit sint",
    "company": "in"
  },
  "footer": "this is footer <p>%sender.address%</p><p><a href=\"%unsubscribelink%\">Unsubscribe here</a></p>",
  "notification": null,
  "active": null,
  "created_at": "2018-02-01 07:27:30"
}


Definition

Patch | https://api.birdsend.co/v1/sequences/{sequence_id}

Request Body Example


{
  "name": "Edit New Sequence",
  "description": "Edit My new sequence",
  "sender": {
    "email": "johndoe@birdsend.com",
    "name": "deserunt ex dolor proident",
    "company": "in",
    "address": "ut sit sint "
  }
}


Response Example

200


{
  "sequence_id": 1,
  "name": "Edit New Sequence",
  "description": "",
  "sender": {
    "email": "johndoe@birdsend.com",
    "name": "deserunt ex dolor proident",
    "address": "ut sit sint",
    "company": "in"
  },
  "footer": "<p>This email was sent to you (%contact.email%) because you opted in on our website and indicated you’d like to receive emails from us. If you no longer wish to receive such emails, please <a href=\"%unsubscribelink%\" target=\"_blank\">unsubscribe here</a></p><p>To ensure you receive our emails, please add <strong>%sender.email%</strong> to your address book.</p><p>Our postal address: %sender.address%</p>",
  "notification": "",
  "active": true,
  "created_at": "2018-01-23 01:33:21"
}


Definition

Delete | https://api.birdsend.co/v1/sequences/{sequence_id}

Response Example

204


---


Definition

Get | https://api.birdsend.co/v1/sequences/{sequence_id}/emails

Response Example

200


{
  "data": [
    {
      "email_id": 1,
      "sequence_id": 1,
      "subject": "New Email",
      "body": "<p>Hi %contact.first_name%</p><p><br></p><p>CONTENT_HERE</p><p><br></p><p>Regards,</p><p>%sender.name%<br><br><br></p>",
      "schedule": {
        "delay": 0,
        "type": "day"
      },
      "stats": {
        "sent": 0,
        "opens": 0,
        "clicks": 0,
        "ltv": 0,
        "bounces": 0,
        "spams": 0,
        "unsubscribes": 0
      },
      "order": 1,
      "active": true
    },
    {
      "email_id": 2,
      "sequence_id": 1,
      "subject": "New Email",
      "body": "<p>Hi %contact.first_name%</p><p><br></p><p>CONTENT_HERE</p><p><br></p><p>Regards,</p><p>%sender.name%<br><br><br></p>",
      "schedule": {
        "delay": 1,
        "type": "day"
      },
      "stats": {
        "sent": 0,
        "opens": 0,
        "clicks": 0,
        "ltv": 0,
        "bounces": 0,
        "spams": 0,
        "unsubscribes": 0
      },
      "order": 2,
      "active": true
    },
    {
      "email_id": 3,
      "sequence_id": 1,
      "subject": "New Email",
      "body": "<p>Hi %contact.first_name%</p><p><br></p><p>CONTENT_HERE</p><p><br></p><p>Regards,</p><p>%sender.name%<br><br><br></p>",
      "schedule": {
        "delay": 1,
        "type": "day"
      },
      "stats": {
        "sent": 0,
        "opens": 0,
        "clicks": 0,
        "ltv": 0,
        "bounces": 0,
        "spams": 0,
        "replies": 0,
        "unsubscribes": 0
      },
      "order": 3,
      "active": true
    }
  ],
  "links": {
    "first": "https://beats.dev/v1/sequences/1/emails?page=1",
    "last": "https://beats.dev/v1/sequences/1/emails?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://beats.dev/v1/sequences/1/emails",
    "per_page": 15,
    "to": 3,
    "total": 3
  }
}


Definition

Get | https://api.birdsend.co/v1/sequences/{sequence_id}/emails/{email_id}

Response Example

200


{
  "email_id": 2,
  "sequence_id": 1,
  "subject": "New Email",
  "body": "<p>Hi %contact.first_name%</p><p><br></p><p>CONTENT_HERE</p><p><br></p><p>Regards,</p><p>%sender.name%<br><br><br></p>",
  "schedule": {
    "delay": 1,
    "type": "day"
  },
  "stats": {
    "sent": 0,
    "opens": 0,
    "clicks": 0,
    "ltv": 0,
    "bounces": 0,
    "spams": 0,
    "unsubscribes": 0
  },
  "order": 2,
  "active": true
}


Definition

Post | https://api.birdsend.co/v1/sequences/{sequence_id}/emails

Request Body Example


{
  "subject": "Create new email",
  "body": "<p>Hi %contact.first_name%</p>ipsum do quis officia",
  "schedule": {
    "delay": 1,
    "type": "hour"
  },
  "active": false
}


Response Example

201


{
  "email_id": 7,
  "sequence_id": 1,
  "subject": "Create new email",
  "body": "<p>Hi %contact.first_name%</p>ipsum do quis officia",
  "schedule": {
    "delay": 1,
    "type": "hour"
  },
  "stats": {
    "sent": 0,
    "opens": 0,
    "clicks": 0,
    "ltv": 0,
    "bounces": 0,
    "spams": 0,
    "unsubscribes": 0
  },
  "order": 2,
  "active": false
}


Definition

Patch | https://api.birdsend.co/v1/sequences/{sequence_id}/emails/{email_id}

Request Body Example


{
  "subject": "Edit new email",
  "body": "<p>Hi %contact.first_name%</p>Edit email message "
}


Response Example

200


{
  "email_id": 7,
  "sequence_id": 1,
  "subject": "Edit new email",
  "body": "<p>Hi %contact.first_name%</p>Edit email message ",
  "schedule": {
    "delay": 1,
    "type": "hour"
  },
  "stats": {
    "sent": 0,
    "opens": 0,
    "clicks": 0,
    "ltv": 0,
    "bounces": 0,
    "spams": 0,
    "unsubscribes": 0
  },
  "order": 2,
  "active": false
}


Definition

Delete | https://api.birdsend.co/v1/sequences/{sequence_id}/emails/{email_id}

Response Example

204


---


Definition

Get | https://api.birdsend.co/v1/tags

Response Example

200


{
  "data": [
    {
      "tag_id": 2,
      "name": "Paid"
    },
    {
      "tag_id": 1,
      "name": "Free"
    }
  ],
  "links": {
    "first": "https://beats.dev/v1/tags?page=1",
    "last": "https://beats.dev/v1/tags?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://beats.dev/v1/tags",
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}


Definition

Get | https://api.birdsend.co/v1/tags/{tag_id}

Response Example

200


{
  "tag_id": 1,
  "name": "Free"
}


Definition

Post | https://api.birdsend.co/v1/tags

Request Body Example


{
  "name": "New Tag"
}


Response Example

201


{
  "tag_id": 3,
  "name": "New Tag"
}


Definition

Patch | https://api.birdsend.co/v1/tags/{tag_id}

Request Body Example


{
  "name": "edit tag"
}


Response Example

200


{
  "tag_id": 1,
  "name": "edit tag"
}


Definition

delete | https://api.birdsend.co/v1/tags/{tag_id}

Response Example

204


---