API docs by Redocly

Bonjoro API V2 (1.0.0)

Download OpenAPI specification:Download

Bonjoro API definitions

Authentications

Authenticate

Request Body schema: application/json
grant_type
string
Enum: "password" "client_credentials" "authorization_code"
username
string <email>
password
string
client_id
string
client_secret
string

Responses

Request samples

Content type
application/json
{
  • "grant_type": "password",
  • "username": "user@example.com",
  • "password": "string",
  • "client_id": "string",
  • "client_secret": "string"
}

Response samples

Content type
application/json
{
  • "token_type": "Bearer",
  • "expires_in": 31536000,
  • "access_token": "eyJ0eXAiOiJKV1QiLCJh...",
  • "refresh_token": "eyJ0eXAiOiJKV1QiLCJh..."
}

Profile Attributes

Get the profile information related to the specified greet_id and profile_id

Authorizations:
None
query Parameters
profile_id
required
string <uuid>
greet_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "message": "Ok",
  • "data": [
    ],
  • "profile_was_updated": false
}

Get all profile attribute types

Authorizations:
None

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Automations

Get paginated automations

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Update an automation

Authorizations:
None
path Parameters
automation_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "fa51a57c-fc9a-4732-b08e-9a6839efa045",
  • "name": "My Funnel",
  • "enabled": false,
  • "is_setup": false,
  • "trigger": {
    },
  • "action": {
    }
}

Update the name or enabled status of an automation

Authorizations:
None
path Parameters
automation_id
required
string <uuid>
Request Body schema: application/json
name
string
enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "New name",
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "id": "fa51a57c-fc9a-4732-b08e-9a6839efa045",
  • "name": "My Funnel",
  • "enabled": false,
  • "is_setup": false,
  • "trigger": {
    },
  • "action": {
    }
}

Delete an automation

Authorizations:
None
path Parameters
automation_id
required
any

Responses

Response samples

Content type
application/json
{
  • "message": "Deleted",
  • "data": {
    }
}

Campaigns

Get paginated campaigns

Authorizations:
None
query Parameters
limit
number

Responses

Response samples

Content type
application/json
{}

Get segmented campaigns

Authorizations:
None

Responses

Response samples

Content type
application/json
{}

Get a campaign

Authorizations:
None
path Parameters
campaign_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{}

Update a campaign

Authorizations:
None
path Parameters
campaign_id
required
string <uuid>
Request Body schema: application/json
type
string or null
Enum: "Default" "Onboarding" "Activation" "Retention" "Team updates" "Prospecting" "Lead Conversion" "Thanking" "Upselling" "Seasonal" "Other"
name
required
string
goal
string or null
is_private
boolean or null
users
Array of strings <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Default",
  • "name": "My Campaign",
  • "goal": "Reach out to all",
  • "is_private": false,
  • "users": [
    ]
}

Response samples

Content type
application/json
{}

Delete a campaign

Authorizations:
None
path Parameters
campaign_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{}

Checklist

Get paginated checklists

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Devices

Add user devices

Authorizations:
None
Request Body schema: application/json
token
required
string
type
required
string
Enum: "ios" "android"
model
string or null
manufacturer
string or null

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "type": "android",
  • "model": "string",
  • "manufacturer": "string"
}

Response samples

Content type
application/json
{
  • "message": "Created",
  • "data": {
    }
}

Domains

Returns the availability of the specified domain

Authorizations:
None
path Parameters
domain_name
required
any
Example: bonjoro.com

Responses

Response samples

Content type
application/json
{
  • "status": "domain_available"
}

Returns paginated domains

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Add a domain

Authorizations:
None
Request Body schema: application/json
domain
string

Responses

Request samples

Content type
application/json
{
  • "domain": "string"
}

Response samples

Content type
application/json
{
  • "message": "Created",
  • "data": {
    }
}

Delete a domain

Authorizations:
None
path Parameters
domain_id
required
any
Example: 10

Responses

Response samples

Content type
application/json
{
  • "message": "Domain deleted",
  • "data": {
    }
}

Verify a domain

Authorizations:
None
path Parameters
domain_id
required
any
Example: 10

Responses

Response samples

Content type
application/json
{
  • "message": "Congrats, your domain is now verified",
  • "data": {
    }
}

Events

Get paginated events

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Feedback

Add a feedback

Authorizations:
None
Request Body schema: application/json
topic
required
string
url
required
string
data
required
Array of any

Responses

Request samples

Content type
application/json
{
  • "topic": "string",
  • "url": "string",
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Created"
}

Greets

Get paginated greets

Authorizations:
None
query Parameters
profile_id
string <uuid>
Example: profile_id=7b9d182a-a687-472b-8212-2c817a7ae088
assignee_id
string <uuid>
Example: assignee_id=7b9d182a-a687-472b-8212-2c817a7ae088
status
string
Enum: "open" "closed" "sent"
Example: status=open
simple
boolean
Example: simple=true
search
string

Search for profiles where email, firstname and lastname matches the search term

sort
string
Enum: "created_at" "updated_at" "uploaded_at" "awaiting_reply" "last_modified" "last_replied_at"
Example: sort=created_at

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Add a greet

Authorizations:
None
Request Body schema: application/json
profiles
Array of strings <email | uuid> <= 200 items

An array of profiles

assignee_id
string or null <uuid>

The assignee of the created task

note
string or null

A note to add to the task

campaign_id
string or null <uuid>

The workspace in which to create the task

template_id
string or null <uuid>

A message template to set for the task

custom_attributes
object or null

Key/value pairs describing custom attributes for the task

Responses

Request samples

Content type
application/json
{
  • "profiles": [
    ],
  • "assignee_id": "7b9d182a-a687-472b-8212-2c817a7ae088",
  • "note": "New signup",
  • "campaign_id": "7b9d182a-a687-472b-8212-2c817a7ae088",
  • "template_id": "7b9d182a-a687-472b-8212-2c817a7ae088",
  • "custom_attributes": { }
}

Response samples

Content type
application/json
{
  • "message": "Created",
  • "data": {
    }
}

Delete multiple greets

Authorizations:
None
query Parameters
greets[]
Array of strings <uuid>

Responses

Response samples

Content type
application/json
{
  • "message": "Deleted",
  • "data": {
    }
}

Updates assignee_id and/or campaign_id of the specified greets

Authorizations:
None
Request Body schema: application/json
assignee_id
string <uuid>
campaign_id
integer
greets
Array of strings

An array of greet uuids

Responses

Request samples

Content type
application/json
{
  • "assignee_id": "7b9d182a-a687-472b-8212-2c817a7ae088",
  • "campaign_id": 5,
  • "greets": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Update the assignee for a greet

Authorizations:
None
path Parameters
greet_id
string <uuid>
Example: 7b9d182a-a687-472b-8212-2c817a7ae088
Request Body schema: application/json
assignee_id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "assignee_id": "7b9d182a-a687-472b-8212-2c817a7ae088"
}

Response samples

Content type
application/json
{
  • "message": "Updated",
  • "data": {
    }
}

Delete a greet

Authorizations:
None
path Parameters
greet_id
string <uuid>
Example: 7b9d182a-a687-472b-8212-2c817a7ae088

Responses

Response samples

Content type
application/json
{
  • "message": "Deleted",
  • "data": {
    }
}

Create greets in bulk

Authorizations:
None
Request Body schema: application/json
assignee_id
string <uuid>
campaign_id
string or null <uuid>
sync
integer or null
Enum: 1 0
reason
string or null <string>
Array of objects

Responses

Request samples

Content type
application/json
{
  • "assignee_id": "a9c34499-8573-4ae5-b596-56aaf4d83b29",
  • "campaign_id": "a9c34499-8573-4ae5-b596-56aaf4d83b29",
  • "sync": 0,
  • "reason": "New Sign Up",
  • "lines": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Created"
}

Mark greet as complete

Authorizations:
None
path Parameters
greet_id
string <uuid>
Example: e885c1ff-0d2e-4b45-a4bb-ea8b09a30a19
Request Body schema: application/json
via
Array of strings
Items Value: "email"

Responses

Request samples

Content type
application/json
{
  • "via": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Sent",
  • "data": {
    }
}

Rollup and delete greets

Authorizations:
None
Request Body schema: application/json
type
string
campaign_id
integer

Responses

Request samples

Content type
application/json
{
  • "type": "no_name",
  • "campaign_id": 5
}

Response samples

Content type
application/json
{
  • "message": "Complete",
  • "data": {
    }
}

Update a greet profile and event message

Authorizations:
None
path Parameters
greet_id
string <uuid>
Example: 7b9d182a-a687-472b-8212-2c817a7ae088
profile_id
string <uuid>
Example: 7b9d182a-a687-472b-8212-2c817a7ae088
Request Body schema: application/json
email
string <email>
first_name
string
last_name
string
message
string

The event message

Responses

Request samples

Content type
application/json
{
  • "email": "email@mail.com",
  • "first_name": "Jane",
  • "last_name": "Foster",
  • "message": "This is an event message"
}

Response samples

Content type
application/json
{}

Delete a greet profile

Authorizations:
None
path Parameters
greet_id
string <uuid>
Example: 7b9d182a-a687-472b-8212-2c817a7ae088
profile_id
string <uuid>
Example: 7b9d182a-a687-472b-8212-2c817a7ae088

Responses

Response samples

Content type
application/json
{
  • "message": "Deleted",
  • "data": {
    }
}

Get paginated greet events

Authorizations:
None
path Parameters
greet_id
string <uuid>
Example: e885c1ff-0d2e-4b45-a4bb-ea8b09a30a19

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Get paginated greet profiles

Authorizations:
None
path Parameters
greet_id
string <uuid>
Example: e885c1ff-0d2e-4b45-a4bb-ea8b09a30a19

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Get paginated greet results

Authorizations:
None
query Parameters
sort
string
Enum: "created_at" "updated_at" "uploaded_at" "awaiting_reply" "last_modified" "last_replied_at"
Example: sort=created_at
assignee_id
string <uuid>
Example: assignee_id=7b9d182a-a687-472b-8212-2c817a7ae088
profile_id
string <uuid>
Example: profile_id=7b9d182a-a687-472b-8212-2c817a7ae088
limit
integer
Example: limit=10
simple
boolean
Example: simple=true

Responses

Response samples

Content type
application/json
{}

Get paginated lightweight greet results stats

Authorizations:
None
query Parameters
sort
string
Enum: "created_at" "updated_at" "uploaded_at" "awaiting_reply" "last_modified" "last_replied_at"
Example: sort=created_at
assignee_id
string <uuid>
Example: assignee_id=7b9d182a-a687-472b-8212-2c817a7ae088
profile_id
string <uuid>
Example: profile_id=7b9d182a-a687-472b-8212-2c817a7ae088
limit
integer
Example: limit=10
simple
boolean
Example: simple=true

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Get paginated greet todos

Authorizations:
None
query Parameters
profile_id
string <uuid>
Example: profile_id=7b9d182a-a687-472b-8212-2c817a7ae088
assignee_id
string <uuid>
Example: assignee_id=7b9d182a-a687-472b-8212-2c817a7ae088
search
string

Search for profiles where email, firstname and lastname matches the search term

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Get S3 upload url for a greet

Authorizations:
None
path Parameters
greet_id
string <uuid>
Example: e885c1ff-0d2e-4b45-a4bb-ea8b09a30a19

Responses

Response samples

Content type
application/json
{}

Update greet metadata

Authorizations:
None
path Parameters
greet_id
string <uuid>
Request Body schema: multipart/form-data
thumbnail
string <binary>
video
string <binary>

DEPRECATED

message_template_id
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "message": "Updated",
  • "data": {
    }
}

Industries

Get valid industries

Responses

Response samples

Content type
application/json
{
  • "industries": {
    }
}

Integrations

Get paginated integrations

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Get an integration

Authorizations:
None
path Parameters
integration_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Invites

Get paginated team invites

Authorizations:
None
query Parameters
team_id
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Add an invite

Authorizations:
None
Request Body schema: application/json
team_id
string <uuid>
email
string <email>
role
string or null
Enum: "admin" "filmer"

Responses

Request samples

Content type
application/json
{
  • "team_id": "810007d0-bec5-486c-b5d1-28fcd8a079ba",
  • "email": "user@example.com",
  • "role": "admin"
}

Response samples

Content type
application/json
{
  • "message": "Created",
  • "data": {
    }
}

Resend an invite

Authorizations:
None
path Parameters
invite_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "message": "Updated",
  • "data": {
    }
}

Delete an invite

Authorizations:
None
path Parameters
invite_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "message": "Deleted",
  • "data": {
    }
}

Login

Retrieve a token via google sign in

query Parameters
auth_code
required
string

Google auth code

Responses

Response samples

Content type
application/json
{
  • "token": {
    }
}

Retrieve a token via branch

query Parameters
token
required
string <uuid>

A user's id

Responses

Response samples

Content type
application/json
{
  • "api_token": {
    }
}

Media

Get all paginated media

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Add a media

Authorizations:
None
Request Body schema: multipart/form-data
file
string <binary>
tags
string

Responses

Response samples

Content type
application/json
{
  • "type": "Media",
  • "name": "like.png",
  • "tags": "logo image",
  • "url": "/example-path-to-url",
  • "id": "a5e7c858-1f85-4fe2-8c1d-4c77cfc3204f",
  • "created_at": "2021-01-11 01:51:26",
  • "updated_at": "2021-01-11 01:51:26"
}

Delete a media

Authorizations:
None
query Parameters
media_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "message": "Deleted",
  • "data": {
    }
}

Message Templates

Get paginated message templates

Authorizations:
None
query Parameters
limit
number

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Add message template

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "message": "Created",
  • "data": {
    }
}

Get message template

Authorizations:
None
path Parameters
message_template_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update message template

Authorizations:
None
path Parameters
message_template_id
required
string <uuid>
Request Body schema: application/json
name
string
is_greet_shareable
boolean
object (mtThemeUpdatePayload)
object (mtLandingPageUpdatePayload)
object (mtEmailTemplate)

Responses

Request samples

Content type
application/json
{
  • "name": "Magic",
  • "is_greet_shareable": true,
  • "theme": {
    },
  • "landing_page": {
    },
  • "email_template": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete message template

Authorizations:
None
path Parameters
message_template_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "message": "Deleted",
  • "data": {
    }
}

Update demo message template

Authorizations:
None
Request Body schema: application/json
object
object (mtThemeUpdatePayload)

Responses

Request samples

Content type
application/json
{
  • "landing_page": {
    },
  • "theme": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Demo Updated",
  • "data": {
    }
}

Notifications

Get paginated notifications

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Mark notification as read

Authorizations:
None
path Parameters
notification_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "Message": "Ok"
}

Pricing

Get all pricing details

Responses

Response samples

Content type
application/json
{
  • "plans": {
    },
  • "features": {
    }
}

Profiles

Get paginated profiles

Authorizations:
None

Responses

Response samples

Content type
application/json
{}

Add profile

Authorizations:
None
Request Body schema: application/json
email
required
string <email>
first_name
string
last_name
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "first_name": "Frank",
  • "last_name": "Castle"
}

Response samples

Content type
application/json
{}

Bulk Update profiles

Authorizations:
None
Request Body schema: application/json
Array of objects (profileBulkUpdatePayload)

Responses

Request samples

Content type
application/json
{
  • "profiles": [
    ]
}

Response samples

Content type
application/json
{}

Get profile

Authorizations:
None
path Parameters
profile_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "email": "mail@mail.com",
  • "name": "Michael Burnham",
  • "first_name": "Michael",
  • "last_name": "Burnham",
  • "image": "http://example-path-to-image.jpg",
  • "work": {
    },
  • "self_url": "http://example-path-to-self-url",
  • "attributes_url": "http://example-path-to-attributes-url",
  • "events_url": "http://example-path-to-events-url",
  • "unsubscribed": true,
  • "id": "a5e7c858-1f85-4fe2-8c1d-4c77cfc3204f",
  • "demographic": {
    },
  • "created_at": "2021-01-11 01:51:26",
  • "updated_at": "2021-01-11 01:51:26",
  • "stats": {
    }
}

Update profile

Authorizations:
None
path Parameters
profile_id
required
string <uuid>
Request Body schema: application/json
email
required
string <email>
first_name
string
last_name
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "first_name": "Frank",
  • "last_name": "Castle"
}

Response samples

Content type
application/json
{}

Recordings

Get paginated recordings

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Update recording

Authorizations:
None
Request Body schema: multipart/form-data
etags
Array of strings
image
string <binary>

Responses

Response samples

Content type
application/json
{
  • "message": "updated",
  • "data": {
    }
}

Get recording

Authorizations:
None
path Parameters
recording_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete recording

Authorizations:
None
path Parameters
recording_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "message": "Deleted"
}

Get recording upload url

Authorizations:
None
path Parameters
recording_id
required
string <uuid>
query Parameters
part_number
required
integer <number>

Responses

Response samples

Content type
application/json
{}

Replies

Get paginated replies

Authorizations:
None
query Parameters
greet_id
required
string <uuid>
propfile_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Add reply

The greet should have a completed/sent status in order to add a reply

Authorizations:
None
Request Body schema: application/json
greet_id
string <uuid>
profile_id
string <uuid>
content
string
author_id
string or null
author_type
string or null
Enum: "profile" "user"

Responses

Request samples

Content type
application/json
{
  • "greet_id": "345c39f8-e2c6-44ee-9d14-4459932e6f7a",
  • "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
  • "content": "This is an example response",
  • "author_id": "1234",
  • "author_type": "profile"
}

Response samples

Content type
application/json
{
  • "content": "This is en example response",
  • "author": {
    },
  • "id": "a5e7c858-1f85-4fe2-8c1d-4c77cfc3204f"
}

Results

Get results for the specified greet and profile

Authorizations:
None
path Parameters
greet_id
required
string <uuid>
profile_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "greet": {
    },
  • "profile": {},
  • "message": "Hi there, I recorded a message for you, check it out!",
  • "stats": {
    },
  • "replies": [
    ],
  • "sent_at": "string",
  • "results_url": "http://example-path-to-results-url",
  • "results_modal_url": "http://example-path-to-results-modal-url",
  • "awaiting_reply": true,
  • "last_replied_at": "2021-01-18 05:21:04"
}

Mark result as replied

Authorizations:
None
path Parameters
greet_id
required
string <uuid>
profile_id
required
string <uuid>
Request Body schema: application/json
mark_as_replied
boolean
Enum: true false

Responses

Request samples

Content type
application/json
{
  • "mark_as_replied": true
}

Response samples

Content type
application/json
{
  • "message": "Updated",
  • "data": {
    }
}

Get lightweight results stats for the specified greet and profile

Authorizations:
None
path Parameters
greet_id
required
string <uuid>
profile_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "greet": {
    },
  • "profile": {},
  • "stats": {
    },
  • "replies": [
    ],
  • "sent_at": "string",
  • "awaiting_reply": true,
  • "last_replied_at": "2021-01-18 05:21:04"
}

Signature Avalabilities

Show the status for the given email address

Authorizations:
None
path Parameters
email_address
required
string <email>
query Parameters
transport_type
required
string
Enum: "transport_google" "transport_microsoft" "transport_postmark" "transport_sparkpost" "postmark_domain"

Responses

Response samples

Content type
application/json
{
  • "status": "email_available"
}

Signatures

Get paginated sender signatures

Authorizations:
None
query Parameters
email
string <email>
transport_type
string
Enum: "transport_google" "transport_microsoft" "transport_postmark" "transport_sparkpost" "postmark_domain"

Required if email parameter is supplied

exclude_default
integer
Enum: 1 0
includes
string
Value: "users.signatures"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Add signature

Authorizations:
None
Request Body schema: application/json
email
string <email>
first_name
string
last_name
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "first_name": "Diana",
  • "last_name": "Bishop"
}

Response samples

Content type
application/json
{
  • "message": "Created",
  • "data": {
    }
}

Delete signature

Authorizations:
None
query Parameters
signature_id
integer
Request Body schema: application/json
from
object

An object containing a userid and a signature id

replyto
object

An object containing a userid and a signature id

Responses

Request samples

Content type
application/json
{
  • "from": {
    },
  • "replyto": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Email deleted",
  • "data": {
    }
}

Verify signature

Authorizations:
None
query Parameters
signature_id
integer

Responses

Response samples

Content type
application/json
{
  • "message": "Please check your inbox for the verification email",
  • "data": {
    }
}

Stats

Get paginated stats

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Get user stats

Authorizations:
None
path Parameters
user_id
required
string <uuid>

A user id that is in the same team

Responses

Response samples

Content type
application/json
{
  • "opens": "1",
  • "views": "1",
  • "clicks": "1",
  • "replies": "1",
  • "reactions": "1",
  • "unique_opens": "1",
  • "unique_views": "1",
  • "unique_clicks": "1",
  • "unique_reactions": "1",
  • "unique_replies": "1",
  • "percentage_opens": "1",
  • "percentage_replies": "1",
  • "total": 1,
  • "minimumComplete": 1,
  • "averageOpens": 1,
  • "averageViews": 1,
  • "averageClicks": 1,
  • "averageReactions": 1
}

Get team stats

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Stock Media

Get paginated stock media

Authorizations:
None
query Parameters
tags
string
limit
required
integer
page
integer

Responses

Response samples

Content type
application/json
{
  • "type": "StockMedia",
  • "name": "example-media-name.jpg",
  • "tags": "background image",
  • "url": "/example-path-to-url-image.jpg",
  • "id": "a5e7c858-1f85-4fe2-8c1d-4c77cfc3204f",
  • "created_at": "2021-01-11 01:51:26",
  • "updated_at": "2021-01-11 01:51:26"
}

Task List

Get tasklist counts

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "counts": {
    }
}

Teams

Get paginated teams

Authorizations:
None
query Parameters
includes
string
Value: "signatures"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Get a team

Authorizations:
None
path Parameters
team_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{}

Update a team landing page subdomain

Authorizations:
None
path Parameters
team_id
required
string <uuid>
Request Body schema: application/json
landing_page_subdomain
string

Responses

Request samples

Content type
application/json
{
  • "landing_page_subdomain": "example-subdomain"
}

Response samples

Content type
application/json
{}

Transmissions

Get transmitted greet data

Authorizations:
None
query Parameters
recipient_id
required
string <uuid>

The profile id of the receipient for the provided context_id

context_id
required
string <uuid>

A valid greet id

Responses

Response samples

Content type
application/json
{
  • "title": "Example title",
  • "status": "bounce",
  • "endpoint": "user@example.com",
  • "created_at": "2021-01-19 23:32:04",
  • "events": [
    ],
  • "user": {},
  • "signature": {
    },
  • "id": "a5e7c858-1f85-4fe2-8c1d-4c77cfc3204f"
}

Users

Get paginated users in the same team

Authorizations:
None
query Parameters
includes
string
Value: "signatures"
limit
number

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Add a user

path Parameters
user_id
required
string <uuid>
Request Body schema: application/json
email
string <email>
password
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "eX@mP13p@$$w0rD"
}

Response samples

Content type
application/json
{}

Get a user

Authorizations:
None
path Parameters
user_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{}

Update a user bio

Authorizations:
None
path Parameters
user_id
required
string <uuid>
Request Body schema: application/json
bio
string

Responses

Request samples

Content type
application/json
{
  • "bio": "Example bio"
}

Response samples

Content type
application/json
{}

Get campaigns for a user

Authorizations:
None
path Parameters
user_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{}

Get segmented campaigns for a user

Authorizations:
None
path Parameters
user_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{}

Update self bio

Authorizations:
None
Request Body schema: application/json
bio
string

Responses

Request samples

Content type
application/json
{
  • "bio": "Example bio"
}

Response samples

Content type
application/json
{}

Update user onboarding info

Authorizations:
None
path Parameters
user_id
required
string <uuid>
Request Body schema: multipart/form-data
object (utmExamplePayload)

Properties may vary

industry
string or null

Retrieve valid values from prismic industries

company
string or null

This will be used as the team name

avatar
string <binary>
email
string <email>
timezone
string
type
string
signature_id
integer

Responses

Response samples

Content type
application/json
{
  • "message": "Updated",
  • "data": {
    }
}

Automation Accounts

Get paginated automation accounts

Authorizations:
None
query Parameters
service
required
string
Enum: "active_campaign" "bonjoro" "convertkit" "drip" "hubspot_crm" "infusionsoft" "intercom" "mailchimp" "mailerlite" "ontraport" "patreon-v2" "shopify" "slack"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Get an automation account

Authorizations:
None
path Parameters
account_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "name": "Slack Account",
  • "service": "slack",
  • "created_at": "2021-01-20 02:38:50",
  • "id": "a5e7c858-1f85-4fe2-8c1d-4c77cfc3204f"
}

Delete an automation account

Authorizations:
None
path Parameters
account_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "message": "Deleted",
  • "data": {
    }
}

Test an automation account

Authorizations:
None
path Parameters
account_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "message": "Ok",
  • "data": { }
}

Automation Actions

Add action

Authorizations:
None
Request Body schema: application/json
service
string
Enum: "active_campaign" "bonjoro" "convertkit" "drip" "hubspot_crm" "infusionsoft" "intercom" "mailchimp" "mailerlite" "ontraport" "patreon-v2" "shopify" "slack"
action
string
trigger_id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "service": "active_campaign",
  • "action": "send_message",
  • "trigger_id": "5727dbbb-3b26-4abe-aec6-181eabbdb21c"
}

Response samples

Content type
application/json
{
  • "message": "Ok",
  • "data": {
    }
}

Update automation action

Authorizations:
None
path Parameters
action_id
required
string <uuid>
Request Body schema: application/json
account_id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65"
}

Response samples

Content type
application/json
{
  • "message": "Updated",
  • "data": {
    }
}

Automation Services

Get all automation services

Authorizations:
None

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an automation service

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "id": "bonjoro",
  • "name": "Bonjoro",
  • "description": "Example description",
  • "logo_url": "/example-path-to-logo.png",
  • "actions": true,
  • "triggers": true,
  • "self_url": "http://example-path-to-self-url",
  • "auth_url": "http://example-path-to-auth-url",
  • "disabled": true,
  • "default_trigger": [
    ],
  • "capability": {
    },
  • "hidden": true,
  • "actions_url": "http://example-path-to-action-url"
}

Get an automation service's contacts

Authorizations:
None
path Parameters
service_id
required
string
query Parameters
account_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Create a new automation assigned to the specified account_id

Authorizations:
None
path Parameters
service_id
required
string
query Parameters
account_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "parameters": {
    }
}

Editor Automations

Get paginated editor automations

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Get an editor automation

Authorizations:
None
path Parameters
automation_id
required
string <uuid>
query Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{}

Update an editor automation

Authorizations:
None
path Parameters
automation_id
required
string <uuid>
Request Body schema: application/json
trigger_id
string <uuid>
action_id
string <uuid>
enabled
boolean
Enum: true false
state
object

Responses

Request samples

Content type
application/json
{
  • "trigger_id": "5727dbbb-3b26-4abe-aec6-181eabbdb21c",
  • "action_id": "52d6fa12-2c88-46da-984a-4cc821c7837a",
  • "enabled": true,
  • "state": {
    }
}

Response samples

Content type
application/json
{
  • "name": "Example name",
  • "enabled": true,
  • "trigger": {
    },
  • "action": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "trigger_id": "5727dbbb-3b26-4abe-aec6-181eabbdb21c",
  • "action_id": "52d6fa12-2c88-46da-984a-4cc821c7837a",
  • "activeStep": "finish"
}

Delete an editor automation

Authorizations:
None
path Parameters
automation_id
required
string <uuid>
Request Body schema: application/json
message
string
object (editorAutomation)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "name": "Example name",
  • "enabled": true,
  • "trigger": {
    },
  • "action": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "trigger_id": "5727dbbb-3b26-4abe-aec6-181eabbdb21c",
  • "action_id": "52d6fa12-2c88-46da-984a-4cc821c7837a",
  • "activeStep": "finish"
}

Editor Automation Actions

Get an editor action for the specified service and trigger

Authorizations:
None
query Parameters
service
required
string
trigger
required
string

Value should be formatted as service_name.trigger_name like 'bonjoro.bonjoro_created'

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Editor Actions

Get an editor action for the specified action_id and service

Authorizations:
None
path Parameters
action_id
required
string
query Parameters
service
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Editor Automation Parameters

Get an editor parameter from the specified item_id and parameter_name

Authorizations:
None
query Parameters
item_id
required
string <uuid>

A valid trigger or action id

parameter_name
required
string

Responses

Response samples

Content type
application/json
{
  • "required": true,
  • "placeholder": "Select a mailing list...",
  • "type": "Dropdown",
  • "description": "Example description",
  • "options": [
    ]
}

Editor Automation Services

Get editor services

Authorizations:
None
query Parameters
type
string or null
Enum: "action" "trigger"
show_hidden
boolean or null
Enum: true false
trigger
string or null

Value should be formatted as service_name.trigger_name like 'bonjoro.bonjoro_created'

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Editor Services

Get an editor service

Authorizations:
None
query Parameters
service_id
required
string
type
string or null
Enum: "action" "trigger"
show_hidden
boolean or null
Enum: true false
trigger
string or null

Value should be formatted as service_name.trigger_name like 'bonjoro.bonjoro_created'

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Editor Automation Triggers

Get all available triggers for the specified service

Authorizations:
None
query Parameters
service
string
Enum: "active_campaign" "bonjoro" "convertkit" "drip" "hubspot_crm" "infusionsoft" "intercom" "mailchimp" "mailerlite" "ontraport" "patreon-v2" "shopify" "slack"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Automation Triggers

Get all automation triggers

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "current_page": 1,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "path": "string",
  • "from": 1,
  • "last_page": 2,
  • "next_page_url": "string",
  • "per_page": 15,
  • "prev_page_url": 0
}

Add a trigger to the specified service

Authorizations:
None
Request Body schema: application/json
service
string
Enum: "active_campaign" "bonjoro" "convertkit" "drip" "hubspot_crm" "infusionsoft" "intercom" "mailchimp" "mailerlite" "ontraport" "patreon-v2" "shopify" "slack"
trigger
string

Responses

Request samples

Content type
application/json
{
  • "service": "active_campaign",
  • "trigger": "bonjoro_created"
}

Response samples

Content type
application/json
{
  • "message": "Ok",
  • "data": {
    }
}

Assign the specified account to the trigger

Authorizations:
None
Request Body schema: application/json
account_id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65"
}

Response samples

Content type
application/json
{
  • "message": "Updated",
  • "data": {
    }
}