Bonjoro

App · 25 actions

Manage video-message tasks and profiles, and read campaigns, templates, results and task activity.

Actions

ActionWhat it does
Complete taskMark greet as complete.
Create profileAdd profile.
Create taskAdd a greet.
Delete taskDelete a greet.
Get automationUpdate an automation.
Get campaignGet a campaign.
Get profileGet profile.
Get teamGet a team.
Get templateGet message template.
Get userGet a user.
List attribute typesGet all profile attribute types.
List automationsGet paginated automations.
List campaignsGet paginated campaigns.
List eventsGet paginated events.
List profilesGet paginated profiles.
List repliesGet paginated replies.
List resultsGet paginated greet results.
List task eventsGet paginated greet events.
List task profilesGet paginated greet profiles.
List tasksGet paginated greets.
List teamsGet paginated teams.
List templatesGet paginated message templates.
List todosGet paginated greet todos.
List usersGet paginated users in the same team.
Update profileUpdate profile.

Complete task

Mark greet as complete.

Inputs

Greet IDgreet_idtextRequired
Greet id.
Viavialist
Via.One or more of: email.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "assignee": {
        "bio": "example",
        "first_name": "example",
        "id": "example",
        "image": "example",
        "last_name": "example",
        "name": "example",
        "self_url": "example",
        "team_url": "example"
      },
      "attributes_url": "example",
      "created_at": "example",
      "draft": false,
      "event": {
        "id": "example",
        "message": "example",
        "occured_at": "example",
        "source": "example",
        "type": "example"
      },
      "events_url": "example",
      "id": "example",
      "link_id": "example",
      "message_template": {
        "created_at": "example",
        "creator": {
          "bio": "example",
          "first_name": "example",
          "id": "example",
          "image": "example",
          "last_name": "example",
          "name": "example",
          "self_url": "example",
          "team_url": "example"
        },
        "email_template": {
          "layout": "html",
          "message_template": "example",
          "subject_line": "example"
        },
        "id": "example",
        "is_greet_shareable": false,
        "landing_page": {
          "background": {
            "created_at": "example",
            "id": "example",
            "name": "example",
            "tags": "example",
            "type": "Media",
            "updated_at": "example",
            "url": "example"
          },
          "background_type": "Media",
          "cta": {
            "created_at": "example",
            "id": "example",
            "is_displayed": false,
            "text": "example",
            "updated_at": "example",
            "url": "example"
          },
          "logo": {
            "created_at": "example",
            "id": "example",
            "name": "example",
            "tags": "example",
            "type": "Media",
            "updated_at": "example",
            "url": "example"
          }
        },
        "name": "example",
        "state": "open",
        "stats": {
          "percentage_clicks": 1,
          "percentage_opens": 1,
          "percentage_reactions": 1,
          "percentage_replies": 1,
          "percentage_views": 1,
          "total": 1
        },
        "theme": {
          "created_at": "example",
          "id": "example",
          "primary_color": "example",
          "secondary_color": "example",
          "updated_at": "example"
        },
        "updated_at": "example"
      },
      "profiles": [],
      "record_url": "example",
      "self_url": "example",
      "status": "example",
      "thumb_url": "example",
      "updated_at": "example",
      "uploads_url": "example"
    },
    "message": "example"
  }
}

Create profile

Add profile.

Inputs

EmailemailtextRequired
Email.
First namefirst_nametext
First name.
Last namelast_nametext
Last name.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "attributes_url": "example",
      "created_at": "example",
      "demographic": {
        "age": "example",
        "country": "example",
        "location": "example",
        "sex": "example"
      },
      "email": "example",
      "events_url": "example",
      "first_name": "example",
      "id": "example",
      "image": "example",
      "last_name": "example",
      "name": "example",
      "self_url": "example",
      "unsubscribed": false,
      "updated_at": "example",
      "work": {
        "current": "example",
        "title": "example"
      }
    },
    "message": "example"
  }
}

Create task

Add a greet.

Inputs

ProfilesprofileslistRequired
An array of profiles
Assigneeassignee_idtext
The assignee of the created task
Notenotetext
A note to add to the task
Campaigncampaign_idtext
The workspace in which to create the task
Templatetemplate_idtext
A message template to set for the task
Custom attributescustom_attributesobject
Key/value pairs describing custom attributes for the task

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "assignee": {
        "bio": "example",
        "first_name": "example",
        "id": "example",
        "image": "example",
        "last_name": "example",
        "name": "example",
        "self_url": "example",
        "team_url": "example"
      },
      "attributes_url": "example",
      "created_at": "example",
      "draft": false,
      "event": {
        "id": "example",
        "message": "example",
        "occured_at": "example",
        "source": "example",
        "type": "example"
      },
      "events_url": "example",
      "id": "example",
      "link_id": "example",
      "message_template": {
        "created_at": "example",
        "creator": {
          "bio": "example",
          "first_name": "example",
          "id": "example",
          "image": "example",
          "last_name": "example",
          "name": "example",
          "self_url": "example",
          "team_url": "example"
        },
        "email_template": {
          "layout": "html",
          "message_template": "example",
          "subject_line": "example"
        },
        "id": "example",
        "is_greet_shareable": false,
        "landing_page": {
          "background": {
            "created_at": "example",
            "id": "example",
            "name": "example",
            "tags": "example",
            "type": "Media",
            "updated_at": "example",
            "url": "example"
          },
          "background_type": "Media",
          "cta": {
            "created_at": "example",
            "id": "example",
            "is_displayed": false,
            "text": "example",
            "updated_at": "example",
            "url": "example"
          },
          "logo": {
            "created_at": "example",
            "id": "example",
            "name": "example",
            "tags": "example",
            "type": "Media",
            "updated_at": "example",
            "url": "example"
          }
        },
        "name": "example",
        "state": "open",
        "stats": {
          "percentage_clicks": 1,
          "percentage_opens": 1,
          "percentage_reactions": 1,
          "percentage_replies": 1,
          "percentage_views": 1,
          "total": 1
        },
        "theme": {
          "created_at": "example",
          "id": "example",
          "primary_color": "example",
          "secondary_color": "example",
          "updated_at": "example"
        },
        "updated_at": "example"
      },
      "profiles": [],
      "record_url": "example",
      "self_url": "example",
      "status": "example",
      "thumb_url": "example",
      "updated_at": "example",
      "uploads_url": "example"
    },
    "message": "example"
  }
}

Delete task

Delete a greet.

Inputs

Greet IDgreet_idtextRequired
Greet id.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "assignee": {
        "bio": "example",
        "first_name": "example",
        "id": "example",
        "image": "example",
        "last_name": "example",
        "name": "example",
        "self_url": "example",
        "team_url": "example"
      },
      "attributes_url": "example",
      "created_at": "example",
      "draft": false,
      "event": {
        "id": "example",
        "message": "example",
        "occured_at": "example",
        "source": "example",
        "type": "example"
      },
      "events_url": "example",
      "id": "example",
      "link_id": "example",
      "message_template": {
        "created_at": "example",
        "creator": {
          "bio": "example",
          "first_name": "example",
          "id": "example",
          "image": "example",
          "last_name": "example",
          "name": "example",
          "self_url": "example",
          "team_url": "example"
        },
        "email_template": {
          "layout": "html",
          "message_template": "example",
          "subject_line": "example"
        },
        "id": "example",
        "is_greet_shareable": false,
        "landing_page": {
          "background": {
            "created_at": "example",
            "id": "example",
            "name": "example",
            "tags": "example",
            "type": "Media",
            "updated_at": "example",
            "url": "example"
          },
          "background_type": "Media",
          "cta": {
            "created_at": "example",
            "id": "example",
            "is_displayed": false,
            "text": "example",
            "updated_at": "example",
            "url": "example"
          },
          "logo": {
            "created_at": "example",
            "id": "example",
            "name": "example",
            "tags": "example",
            "type": "Media",
            "updated_at": "example",
            "url": "example"
          }
        },
        "name": "example",
        "state": "open",
        "stats": {
          "percentage_clicks": 1,
          "percentage_opens": 1,
          "percentage_reactions": 1,
          "percentage_replies": 1,
          "percentage_views": 1,
          "total": 1
        },
        "theme": {
          "created_at": "example",
          "id": "example",
          "primary_color": "example",
          "secondary_color": "example",
          "updated_at": "example"
        },
        "updated_at": "example"
      },
      "profiles": [],
      "record_url": "example",
      "self_url": "example",
      "status": "example",
      "thumb_url": "example",
      "updated_at": "example",
      "uploads_url": "example"
    },
    "message": "example"
  }
}

Get automation

Update an automation.

Inputs

Automation IDautomation_idtextRequired
Automation id.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "action": {
      "id": "example",
      "logo_url": false,
      "name": "example",
      "service_id": false,
      "short_name": false
    },
    "enabled": false,
    "id": "example",
    "is_setup": false,
    "name": "example",
    "trigger": {
      "id": "example",
      "logo_url": false,
      "name": "example",
      "service_id": false,
      "short_name": false
    }
  }
}

Get campaign

Get a campaign.

Inputs

Campaigncampaign_idtextRequired
Campaign id.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "archived_at": "example",
      "creator": {
        "bio": "example",
        "first_name": "example",
        "id": "example",
        "image": "example",
        "last_name": "example",
        "name": "example",
        "self_url": "example",
        "team_url": "example"
      },
      "goal": "example",
      "id": 1,
      "is_default": false,
      "is_private": false,
      "name": "example",
      "slug": "example",
      "type": "example",
      "uuid": "example"
    }
  }
}

Get profile

Get profile.

Inputs

Profile IDprofile_idtextRequired
Profile id.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "attributes_url": "example",
    "created_at": "example",
    "demographic": {
      "age": "example",
      "country": "example",
      "location": "example",
      "sex": "example"
    },
    "email": "example",
    "events_url": "example",
    "first_name": "example",
    "id": "example",
    "image": "example",
    "last_name": "example",
    "name": "example",
    "self_url": "example",
    "stats": {
      "clicked": false,
      "clicks": 1,
      "date_opened": "example",
      "date_replied": "example",
      "opened": false,
      "opens": 1,
      "reacted": false,
      "reactions": 1,
      "recipient_replied": false,
      "shared": false,
      "shares": 1,
      "viewed": false,
      "views": 1,
      "watched": false
    },
    "unsubscribed": false,
    "updated_at": "example",
    "work": {
      "current": "example",
      "title": "example"
    }
  }
}

Get team

Get a team.

Inputs

Team IDteam_id_valuetextRequired
Team id value.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "id": "example",
    "invites_url": "example",
    "landing_page_host": "example",
    "landing_page_subdomain": "example",
    "links_url": "example",
    "name": "example",
    "owner_id": "example",
    "owner_url": "example",
    "self_url": "example"
  }
}

Get template

Get message template.

Inputs

Message template IDmessage_template_idtextRequired
Message template id.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "created_at": "example",
      "creator": {
        "bio": "example",
        "first_name": "example",
        "id": "example",
        "image": "example",
        "last_name": "example",
        "name": "example",
        "self_url": "example",
        "team_url": "example"
      },
      "email_template": {
        "layout": "html",
        "message_template": "example",
        "subject_line": "example"
      },
      "id": "example",
      "is_greet_shareable": false,
      "landing_page": {
        "background": {
          "created_at": "example",
          "id": "example",
          "name": "example",
          "tags": "example",
          "type": "Media",
          "updated_at": "example",
          "url": "example"
        },
        "background_type": "Media",
        "cta": {
          "created_at": "example",
          "id": "example",
          "is_displayed": false,
          "text": "example",
          "updated_at": "example",
          "url": "example"
        },
        "logo": {
          "created_at": "example",
          "id": "example",
          "name": "example",
          "tags": "example",
          "type": "Media",
          "updated_at": "example",
          "url": "example"
        }
      },
      "name": "example",
      "state": "open",
      "stats": {
        "percentage_clicks": 1,
        "percentage_opens": 1,
        "percentage_reactions": 1,
        "percentage_replies": 1,
        "percentage_views": 1,
        "total": 1
      },
      "theme": {
        "created_at": "example",
        "id": "example",
        "primary_color": "example",
        "secondary_color": "example",
        "updated_at": "example"
      },
      "updated_at": "example"
    }
  }
}

Get user

Get a user.

Inputs

User IDuser_id_valuetextRequired
User id value.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "bio": "example",
    "first_name": "example",
    "id": "example",
    "image": "example",
    "last_name": "example",
    "name": "example",
    "self_url": "example",
    "team_url": "example"
  }
}

List attribute types

Get all profile attribute types.

Inputs

None.

Outputs

datalist
Returned value.
Example output
{
  "data": []
}

List automations

Get paginated automations.

Inputs

None.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}

List campaigns

Get paginated campaigns.

Inputs

Limitlimitnumber
Limit.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}

List events

Get paginated events.

Inputs

None.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}

List profiles

Get paginated profiles.

Inputs

None.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "attributes_url": "example",
    "created_at": "example",
    "demographic": {
      "age": "example",
      "country": "example",
      "location": "example",
      "sex": "example"
    },
    "email": "example",
    "events_url": "example",
    "first_name": "example",
    "id": "example",
    "image": "example",
    "last_name": "example",
    "name": "example",
    "self_url": "example",
    "unsubscribed": false,
    "updated_at": "example",
    "work": {
      "current": "example",
      "title": "example"
    }
  }
}

List replies

Get paginated replies.

Inputs

Greet IDgreet_idtextRequired
Greet id.
Profile IDpropfile_idtextRequired
Propfile id.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}

List results

Get paginated greet results.

Inputs

Sortsorttext
Sort.One of: created_at (Created at), updated_at (Updated at), uploaded_at (Uploaded at), awaiting_reply (Awaiting reply), last_modified (Last modified), last_replied_at (Last replied at).
Assigneeassignee_idtext
Assignee id.
Profile IDprofile_idtext
Profile id.
Limitlimitnumber
Limit.
Simplesimpletrue/false
Simple.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}

List task events

Get paginated greet events.

Inputs

Greet IDgreet_idtextRequired
Greet id.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}

List task profiles

Get paginated greet profiles.

Inputs

Greet IDgreet_idtextRequired
Greet id.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}

List tasks

Get paginated greets.

Inputs

Profile IDprofile_idtext
Profile id.
Assigneeassignee_idtext
Assignee id.
Statusstatustext
Status.One of: open, closed, sent.
Simplesimpletrue/false
Simple.
Searchsearchtext
Search for profiles where email, firstname and lastname matches the search term
Sortsorttext
Sort.One of: created_at (Created at), updated_at (Updated at), uploaded_at (Uploaded at), awaiting_reply (Awaiting reply), last_modified (Last modified), last_replied_at (Last replied at).

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}

List teams

Get paginated teams.

Inputs

Includesincludestext
Includes.One of: signatures.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}

List templates

Get paginated message templates.

Inputs

Limitlimitnumber
Limit.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}

List todos

Get paginated greet todos.

Inputs

Profile IDprofile_idtext
Profile id.
Assigneeassignee_idtext
Assignee id.
Searchsearchtext
Search for profiles where email, firstname and lastname matches the search term

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}

List users

Get paginated users in the same team.

Inputs

Includesincludestext
Includes.One of: signatures.
Limitlimitnumber
Limit.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "example",
    "from": 1,
    "last_page": 1,
    "last_page_url": "example",
    "next_page_url": "example",
    "path": "example",
    "per_page": 1,
    "prev_page_url": 1
  }
}

Update profile

Update profile.

Inputs

Profile IDprofile_idtextRequired
Profile id.
Emailemailtext
Email.
First namefirst_nametext
First name.
Last namelast_nametext
Last name.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "attributes_url": "example",
    "created_at": "example",
    "demographic": {
      "age": "example",
      "country": "example",
      "location": "example",
      "sex": "example"
    },
    "email": "example",
    "events_url": "example",
    "first_name": "example",
    "id": "example",
    "image": "example",
    "last_name": "example",
    "name": "example",
    "self_url": "example",
    "unsubscribed": false,
    "updated_at": "example",
    "work": {
      "current": "example",
      "title": "example"
    }
  }
}

On this page