Communications

The communications endpoints can be used to send emails & text messages, view notifications, manage custom domains & sender signatures, etc.

Add Domain Name

Adds a domain name that can be used to send more customized email addresses from. By adding a domain name, emails can come from emails such as `username@yourDomainName` instead of `notifications@BoathouseConnect.com`. This gives you more control over the branding of emails sent to your users and stakeholders.

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
domain Domain name to link to the whitelabel.
Try It!
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:
IdNameDescription
12 Manage Communications Allowed to change communications settings such as custom domain name settings, send hours, and other email settings.
17 Manage Organization Settings Allowed to change basic organization-related settings, such as uploading logos, setting timezone, etc.

Sample Responses

                            [{"whitelabel_id":127,"name":"rower.club","spf_verified":"true","spf_host":"rower.club","spf_text_value":"v=spf1 a mx include:spf.mtasv.net ~all","dkim_verified":"true","weak_dkim":"false","dkim_host":"20200913191825pm._domainkey.rower.club","dkim_text_value":"k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQArJ0BjKbRaiombpDUSQS+h3OKhDHXEJf\/M8MTFPk6lI6kHrsCE1c+qv7KBYeQYwC10489ApYt3yF7zSl8uYQvGTlkmWvN0DdIZMG3Y\/hxFMDucQogSpoBU49tNGbefnUjOlrCghaP7GX55oticbVgpeHFvce6TjTUFuD\/HzaxvQIDAQAB","dkim_pending_host":"","dkim_pending_text_value":"","dkim_revoked_host":"","dkim_revoked_text_value":"","safe_to_remove_revoked_key_from_dns":"false","dkim_update_status":"Verified","return_path_domain":"bhconnect-bounces.rower.club","return_path_domain_verified":"true","return_path_domain_cname_value":"pm.mtasv.net","id":1731437},{"whitelabel_id":127,"name":"rowerforms.com","spf_verified":"true","spf_host":"rowerforms.com","spf_text_value":"v=spf1 a mx include:spf.mtasv.net ~all","dkim_verified":"false","weak_dkim":"false","dkim_host":"","dkim_text_value":"","dkim_pending_host":"20200913230024pm._domainkey.rowerforms.com","dkim_pending_text_value":"k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQ6iqOfA8OG2XgbgTHt6YoSvvkebhxWetlsL\/gi8Kxo4WaufrieDH0423sJLF33i8aN\/e51jdcVmrInKkqtEb++p\/cDR5TUnBwWyZBhhHk50zUQ2aDM\/Fbl\/BG5058w9VRBlkzEpym2Tf8975GyCsvXhqWHF7U9xybTE3MBwIDAQAB","dkim_revoked_host":"","dkim_revoked_text_value":"","safe_to_remove_revoked_key_from_dns":"false","dkim_update_status":"Pending","return_path_domain":"bhconnect-bounces-127.rowerforms.com","return_path_domain_verified":"false","return_path_domain_cname_value":"pm.mtasv.net","id":1731476}]
                        
                            []
Success Response Key

Get Domain Names

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
Try It!
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:
IdNameDescription
12 Manage Communications Allowed to change communications settings such as custom domain name settings, send hours, and other email settings.
17 Manage Organization Settings Allowed to change basic organization-related settings, such as uploading logos, setting timezone, etc.

Sample Responses

                            []
                        
                            []
Success Response Key

Reload Domain DNS

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
domain_id Id of the domain name to refresh.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Create Email Sender Signature

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
domain Domain name to add signature to.
username Username portion of the from email (ex: username@mydomain.com).
name From name for all emails sent with the signature (ex: `Our Club Updates`).
Try It!
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:
IdNameDescription
12 Manage Communications Allowed to change communications settings such as custom domain name settings, send hours, and other email settings.
17 Manage Organization Settings Allowed to change basic organization-related settings, such as uploading logos, setting timezone, etc.

Sample Responses

                            []
                        
                            []
Success Response Key

Delete Email Sender Signature

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
signature_id Id of the signature to delete.
Try It!
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:
IdNameDescription
12 Manage Communications Allowed to change communications settings such as custom domain name settings, send hours, and other email settings.
17 Manage Organization Settings Allowed to change basic organization-related settings, such as uploading logos, setting timezone, etc.

Sample Responses

                            []
                        
                            []
Success Response Key

Get All Email Sender Signatures

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Get Default Email Sender Signatures

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Delete Default Sender Signature

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
slug Id of message type to remove the default signature for.
Try It!
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:
IdNameDescription
12 Manage Communications Allowed to change communications settings such as custom domain name settings, send hours, and other email settings.
17 Manage Organization Settings Allowed to change basic organization-related settings, such as uploading logos, setting timezone, etc.

Sample Responses

                            []
                        
                            []
Success Response Key

Update Default Email Sender Signature

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
slug Id of message type to update.
signature_id Id of the signature to set as the default.
Try It!
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:
IdNameDescription
12 Manage Communications Allowed to change communications settings such as custom domain name settings, send hours, and other email settings.
17 Manage Organization Settings Allowed to change basic organization-related settings, such as uploading logos, setting timezone, etc.

Sample Responses

                            []
                        
                            []
Success Response Key

Create New Message

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Get Message

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
message_id Id of the email or text message.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Change Message Type

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
message_id Id of the email or text message.
type Type of message to convert the message to (`text` or `email`).
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Add Group to Message Recipients

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
message_id Id of the email or text message.
group_id Id of the group to add to the recipients list.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Add Stakeholders to Message Recipients

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
message_id Id of the email or text message.
group_id Id of the group to add all stakeholders of to the recipients list.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Remove Group From Recipients

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
message_id Id of the email or text message.
group_id Id of the group to remove from the recipients list.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Remove Stakeholders From Recipients

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
message_id Id of the email or text message.
group_id Id of the group to remove all stakeholders from the recipients list.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Update Message Subject Line

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
message_id Id of the email or text message.
subject New subject line for the email.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Update Message Body

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
message_id Id of the email or text message.
body Body of the email (can be HTML).
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Update Message Send Time

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
message_id Id of the email or text message.
scheduled_time UNIX timestamp of when the message should be sent.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Mark Message Ready To Send

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
message_id Id of the email or text message.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Approve/Decline Message To Send

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
message_id Id of the email or text message.
approval `Yes` or `No` as to whether the message is now approved.
Try It!
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:
IdNameDescription
12 Manage Communications Allowed to change communications settings such as custom domain name settings, send hours, and other email settings.
13 Send Communications to Allowed Groups Allowed to send emails / text messages to groups the user is a member of.
14 Approve Communications Approve communications requested to be sent by users not authorized to send communications. Only allowed in groups you are a member of.
15 Manage Communications Stakeholders Allowed to create/manage stakeholder lists for groups you are a member of.

Sample Responses

                            []
                        
                            []
Success Response Key

Delete Scheduled Message

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
message_id Id of the email or text message.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Get First Open and Click

Retrieves the first time an email was opened and clicked for each recipient that has opened the email or clicked a link in an email.

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
message_id Id of the email or text message.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            {"opens":[{"external_id":"0c3e9d08-68d2-4f23-88a3-ad4d3a8e5820","activity":"Open","open_time":1604025869,"name":"Sean Tribe","custid":0,"sent_time":1604010662,"time_from_sent":15207},{"external_id":"765d70c8-d968-4f0e-8845-a10fe45593df","activity":"Open","open_time":1604242176,"name":"John McDaniel","custid":0,"sent_time":1604010662,"time_from_sent":231514},{"external_id":"32f46a7c-cb26-420c-9a3b-da25fdf4decf","activity":"Open","open_time":1604012270,"name":"Michael Testerson","custid":0,"sent_time":1604010662,"time_from_sent":1608},{"external_id":"4aef5d53-ddcd-45bc-aeef-d043f5f191ae","activity":"Open","open_time":1604010719,"name":"Olivia Standard","custid":0,"sent_time":1604010662,"time_from_sent":57}],"clicks":[{"external_id":"765d70c8-d968-4f0e-8845-a10fe45593df","activity":"Click","click_time":1604242179,"name":"Sean Tribe","custid":0,"sent_time":1604010662,"time_from_sent":231517},{"external_id":"4aef5d53-ddcd-45bc-aeef-d043f5f191ae","activity":"Click","click_time":1604027210,"name":"Michael Testerson","custid":0,"sent_time":1604010662,"time_from_sent":16548},{"external_id":"98674899-225d-4afd-acda-5777d0033508","activity":"Click","click_time":1604016013,"name":"Mark Sless","custid":0,"sent_time":1604010662,"time_from_sent":5351}]}
                        
                            []
Success Response Key

Get My Messages

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Get Scheduled Messages

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
approval_required (optional) Whether or not to only grab messages that currently require approval. `Yes`, `No`, or `All`.
type (optional) Type of message. `Email`, `Text`, or `All`.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Get Sent Messages

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
type (optional) Type of messages to retrieve (`Email`, `Text` or `All`).
limit (optional) Maximum number of messages to return (defaults to 1000).
since (optional) UNIX timestamp of the latest message to pull from (based on sort parameter).
sort (optional) `ASC` or `DESC`, Order you want messages to be sorted by send time.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Get All Email Templates

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Create Email Template

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
title Name of the new email template.
subject Subject line for the email.
body Body of the email template.
Try It!
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:
IdNameDescription
12 Manage Communications Allowed to change communications settings such as custom domain name settings, send hours, and other email settings.

Sample Responses

                            []
                        
                            []
Success Response Key

Add Group to Email Template

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
group_id Id of the group to assign the template to.
template_id Id of the template to assign to the group.
Try It!
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:
IdNameDescription
12 Manage Communications Allowed to change communications settings such as custom domain name settings, send hours, and other email settings.

Sample Responses

                            [{"whitelabel_id":127,"email_template_id":1,"subject":"Welcome to Learn-to-Row","template_name":"LTR Welcome","message_body":"This is a welcome email informing you of our LTR offerings!","last_updated":1628219029,"total_sends":14,"total_reads":"7","total_clicks":"4","emails_sent":[{"whitelabel_id":127,"template_id":1,"timestamp_sent":1628222793,"custid":564,"fname":"Michael","lname":"Testington","email_address":"Michaeltest@BoathouseConnect.com","external_id":"0ae700cb-c3d3-43f0-a5ee-aead3cd7be09","read_count":2,"click_count":0},{"whitelabel_id":127,"template_id":1,"timestamp_sent":1628222793,"custid":126526,"fname":"Olivia","lname":"Brown","email_address":"oliviabrown@boathouseconnect.com","external_id":"a265400b-be97-4dd8-ba41-6aaefd55c2ab","read_count":5,"click_count":0}],"groups_linked":[{"whitelabel_id":127,"template_id":1,"group_id":52,"group_title":"Email Testers","group_descr":"Group of users to test emails with."},{"whitelabel_id":127,"template_id":1,"group_id":62,"group_title":"LTR Athletes","group_descr":"All Learn-to-Row athletes"}],"non_linked_groups":[{"whitelabel_id":127,"group_id":44,"group_title":"Super Admin","group_descr":"Access to everything. Able to grant\/revoke permissions for all groups. Able to do everything. Warning: Only add users to this group that should have permission to manage the entire organization. Strongly recommend limiting to organization president and vice-president..."},{"whitelabel_id":127,"group_id":45,"group_title":"Coach","group_descr":"Allowed to create and manage team practices which includes setting lineups, viewing user contact\/personal details (along with emergency contacts), planning regattas and send communications.?"},{"whitelabel_id":127,"group_id":46,"group_title":"General Member","group_descr":"Limited access. Cannot make any changes that affect any other members or the entire organization."}]},[]]
                        
                            []
Success Response Key

Remove Group From Email Template

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
group_id Id of the group to remove the template from.
template_id Id of the template to remove from the group.
Try It!
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:
IdNameDescription
12 Manage Communications Allowed to change communications settings such as custom domain name settings, send hours, and other email settings.

Sample Responses

                            []
                        
                            []
Success Response Key

Set Join Email Template

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
action `Add` or `Remove`.
template_id Id of the template to remove from the group.
Try It!
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:
IdNameDescription
12 Manage Communications Allowed to change communications settings such as custom domain name settings, send hours, and other email settings.

Sample Responses

                            []
                        
                            []
Success Response Key

Update Email Template

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
title Name of the new email template.
subject Subject line for the email.
body Body of the email template.
title (optional) Name of the new email template.
subject (optional) Subject line for the email.
body (optional) Body of the email template.
Try It!
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:
IdNameDescription
12 Manage Communications Allowed to change communications settings such as custom domain name settings, send hours, and other email settings.

Sample Responses

                            []
                        
                            []
Success Response Key

Update Social Media Link

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
platform Social media platform (facebook, instagram, youtube, twitter).
newurl URL to include as the link.
Try It!
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:
IdNameDescription
12 Manage Communications Allowed to change communications settings such as custom domain name settings, send hours, and other email settings.
17 Manage Organization Settings Allowed to change basic organization-related settings, such as uploading logos, setting timezone, etc.

Sample Responses

                            []
                        
                            []
Success Response Key

Don't like coding?

Checkout our integration with Zapier! Zapier is a platform that allows you to connect Boathouse Connect to over 3,000+ other applications & services Go To Zapier




Overview

Actions

About Us

Copyright © 2011-2024 Merwin Software, LLC / Boathouse Connect