Javascript client for the BombBomb API
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


We make it easy to build relationships using simple videos.

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: 2.0.831
  • Package version: 2.0.25798
  • Build package: io.swagger.codegen.languages.PhpClientCodegen


PHP 5.5 and later

Installation & Usage


To install the bindings via Composer, add the following to composer.json:

  "repositories": [
      "type": "git",
      "url": ""
  "require": {
    "bombbomb/bombbomb": "*@dev"

Then run composer install

Manual Installation

Download the files and include autoload.php:



To run the unit tests:

composer install

Getting Started

Please follow the installation procedure and then run the following:

require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: BBOAuth2
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\AccountsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),

try {
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->accountDetails: ', $e->getMessage(), PHP_EOL;


Documentation for API Endpoints

All URIs are relative to

Class Method HTTP request Description
AccountsApi accountDetails GET /accounts Get account details.
AccountsApi createAccount POST /accounts Create Account
AccountsApi getClientStatistics GET /accounts/stats Get Client Statistics
AccountsApi getUserCountry GET /accounts/{clientId}/country Gets user country
AccountsApi resetApiKey PUT /accounts/apikey Reset API key
AccountsApi subscriptionPurchaseAllowed GET /accounts/purchaseable Check if subscription purchase allowed.
AccountsApi updateProfileData POST /account/profile/ Add profile information.
AutomationsApi getDripDropStats GET /automation/{dripId}/dripdrop/{dripDropId}/stats Get Automation Email Stats
AutomationsApi getDripStats GET /automation/{id}/stats Get Automation Stats
AutomationsApi getSchedulingStatus GET /automation/{id}/scheduling/status Get the number of pending scheduling calculations
ContactsApi addContactsCSV POST /contacts/import_csv Add contacts from a CSV file.
ContactsApi addNewContact POST /contacts/ Add a contact.
ContactsApi addNewCustomField POST /contacts/custom_fields/ Add custom fields.
ContactsApi addPastedContacts POST /contacts/paste Add pasted contacts.
ContactsApi cSVToObject POST /csv-to-object Format CSV.
ContactsApi deleteContacts PUT /contacts/delete Delete Contacts
ContactsApi getContactById GET /contact/{id} Get Contact Details
ContactsApi getCustomFields GET /contacts/custom_fields/ Get custom fields.
CurriculumApi getCurricula GET /curricula/ Get Curricula
CurriculumApi getUserCurriculumWithProgress GET /curriculum/getForUserWithProgress Get Detailed For User
EmailsApi createPrintingPressEmail POST /emails/print Create an Email with Printing Press
EmailsApi getAllTemplatesForCurrentUser GET /emails/templates Get all user templates
EmailsApi getEmailTracking GET /emails/{emailId}/tracking Get Email Tracking
EmailsApi getEmailTrackingInteractions GET /emails/{emailId}/tracking/interactions Get Email Tracking Interactions
EmailsApi getHourlyEmailTracking GET /emails/{emailId}/tracking/hourly Get Hourly Email Tracking
EmailsApi getLiveFireData GET /emails/livefire Get livefire feed data
EmailsApi getQuickSendTemplates GET /emails/quicksend/templates Get all quicksend templates
EmailsApi getTemplateHtmlForTemplateId GET /emails/templates/{templateId}/html Get the HTML for a given template
EmailsApi getVideoQuickSenderData GET /emails/quicksend Get quicksend data
EmailsApi saveQuickSenderSettings POST /emails/quicksend/settings Save quicksender settings
EmailsApi videoQuickSender POST /emails/quicksend Send a quicksend email
FilesApi docHostDelete DELETE /files/{docId} Delete file
FilesApi docHostGet GET /files/{docId} Get file
FilesApi docHostList GET /files List all files
FilesApi docHostUploadV2 POST /files Upload a file
FilesApi getHostedImagesPaged GET /files/images/paged Get paged hosted images
FormsApi getFormTrackingAsCsv GET /forms/{id}/tracking/export Get csv
IntegrationsApi connectIntegration POST /integrations Activate an integration for a user.
IntegrationsApi deleteIntegration DELETE /integrations Remove an integration for a user.
IntegrationsApi getIntegrationHealth GET /integrations/health/{code} Get health for a given integration
IntegrationsApi getIntegrationPageComponents GET /integrations/pageComponents Get page components for a given integration
IntegrationsApi syncUsersIntegratedLists GET /integrations/sync Synchronize your integration list or lists.
ListsApi addNewList POST /lists/ Add list.
ListsApi clearList PUT /lists/{listId}/clear Clear Contacts from List
ListsApi copyListContacts POST /lists/{listId}/copy Copy All Contacts from a List
ListsApi getAllLists GET /lists/ Get all Lists
ListsApi suppressAllInList PUT /lists/{listId}/suppress Suppress All Contacts from List
OrdersApi templateAssetDelete DELETE /orders/templates/images Deletes image from user s3 store
PromptsApi createPromptBot POST /prompts/bots Create a running Prompt Bot for a list
PromptsApi createVideoEmailPrompt POST /prompt Prompts user to send a video
PromptsApi getAlternateCampaignContent GET /campaign/{campaignId}/content/alternate List alternate campaign content
PromptsApi getPendingVideoEmailPrompts GET /prompt/pending List pending prompts
PromptsApi getPromptBots GET /prompts/bots List Prompt Bots
PromptsApi getPromptCampaigns GET /prompts/{userId}/campaigns List Prompt Campaigns
PromptsApi getVideoEmailPrompt GET /prompt/{id} Gets a prompt
PromptsApi getVideoEmailPrompts GET /prompt/ List prompts
PromptsApi respondToVideoEmailPrompt POST /prompt/{id}/response Respond to a prompt
PromptsApi sendPromptImmediately POST /prompt/{id}/sendit
PromptsApi syncPromptSubscriptions POST /prompts/campaigns/sync Syncs Campaigns and One to Ones Subscriptions for User
PromptsApi updatePrompt PUT /prompts/{id} Update Prompt
PromptsApi updatePromptBot PUT /prompts/bots/{id} Update Prompt Bot
PromptsApi updatePromptCampaign PUT /prompts/campaigns/{clientGroupId} Update Prompt Campaign
PromptsApi updatePromptTemplate PUT /prompts/{id}/content Update Prompt Content
SocialsApi getFacebookPages GET /socials/facebook/pages Gets facebook pages
SocialsApi getSocialArticleProperties GET /socials/properties Gets the social email properties
SocialsApi getSocialAuthorizations GET /socials/authorizations Get authorizations for all social integration
SocialsApi getSocialProfileProperties GET /socials/profile Gets the profile properties
SocialsApi getSocialStats GET /socials/{promptId}/stats Get social stats for a prompt
SocialsApi postSocialContent POST /socials/content Creates social content
SocialsApi retrySocialSend POST /socials/send/retry Sends social content
SocialsApi sendSocial POST /socials/send Sends social content
SocialsApi updateClientGroupSendMechanism PUT /socials/client/sendMechanism Gets the auto shares from the client group assoc id
SocialsApi updateClientGroupsSendMechanism PUT /socials/client/sendMechanisms Toggles the prompt campaigns in a users account
SocialsApi updateFacebookPages PUT /socials/facebook/pages Updates facebook page Ids
SocialsApi updateSocialContent PUT /socials/content Updates social content
TeamsApi addTeamMember POST /team/{teamId}/member Add Member to Team
TeamsApi addUsers POST /team/{teamId}/members Add users to group.
TeamsApi addUsersFromCsv POST /team/{teamId}/members/csv Add members to group from CSV
TeamsApi cancelJerichoSend DELETE /team/{teamId}/jericho/{jerichoId} Cancel a Jericho Send
TeamsApi createSubteam POST /team/{teamId}/subteam Add a Subteam
TeamsApi deleteSubteam DELETE /team/{teamId}/subteam Delete Subteam
TeamsApi getAllClientGroupAssociations GET /team/associations/ Lists team associations
TeamsApi getClientGroupAssets GET /team/assets/ Lists team assets
TeamsApi getClientGroupStatistics GET /team/{teamId}/stats Get Team statistics
TeamsApi getJerichoSends GET /team/{teamId}/jericho List Jericho Sends
TeamsApi getJerichoStats GET /team/{teamId}/jericho/{jerichoId}/performance Gets Jericho performance statistics
TeamsApi getPagedClientGroupMembers GET /team/{teamId}/members List Team Members
TeamsApi getPromptMonthlyStats GET /team/{month}/{year}/monthStats Jericho Monthly Stats
TeamsApi getPromptOverview GET /team/promptOverview Get Prompt Overview
TeamsApi getSubteams GET /team/{teamId}/subteam List Subteams
TeamsApi getTeamPromptAggregateStats GET /team/{clientGroupId}/campaign/stats Get aggregate stats for campaigns
TeamsApi getTeamPromptCampaigns GET /team/{clientGroupId}/campaign Get campaigns for team
TeamsApi inviteToSocialPromptTeam POST /teams/prompt/invite Invite a list to join the admin's social prompt team
TeamsApi queueJerichoSend POST /team/{teamId}/jericho Creates a Jericho send.
TeamsApi removeMemberFromTeam DELETE /team/{teamId}/member/{userId} Remove Member from Team
TeamsApi resendTeamMemberInvitation POST /team/{teamId}/{memberUserId}/rewelcome Resend invite
TeamsApi updateJerichoPromptSend PUT /team/{teamId}/jericho/{jerichoId} Updates the Jericho Prompt Settings
TeamsApi updateTeam POST /team/{teamId} Update a team
TeamsApi updateTeamMember PUT /team/{teamId}/member Update Member of Team
UsersApi getClientContactInformation GET /clients/contact/information Get client contact information.
UsersApi getUserProfileInfo GET /users/profile/information Get user profile information.
UtilitiesApi createOAuthClient POST /oauthclient Create an OAuth Client
UtilitiesApi deleteOAuthClient DELETE /oauthclient/{id} Delete an OAuth Client
UtilitiesApi getOAuthClients GET /oauthclient Lists OAuth Clients
UtilitiesApi getSpec GET /spec Describes this api
VideosApi getVideoEncodingStatus GET /videos/{videoId}/status Video Encoding Status
VideosApi getVideoRecorder GET /videos/live/getRecorder Get Live Video Recorder HTML
VideosApi markLiveRecordingComplete POST /videos/live/markComplete Completes a live recording
VideosApi signUpload POST /video/signedUpload Generate Signed Url
VideosApi updateVideoThumbnailV2 PUT /videos/thumbnail Upload thumbnail
WebhooksApi addWebHook POST /webhook Add Webhook
WebhooksApi deleteWebHook DELETE /webhook/{hookId} Deletes Webhook
WebhooksApi getWebHooks GET /webhook/ Lists Webhooks
WebhooksApi listWebHookEvents GET /webhook/events Describe WebHook Events
WebhooksApi sendWebhookExample POST /webhook/test Sends test Webhook

Documentation For Models

Documentation For Authorization


  • Type: OAuth
  • Flow: implicit
  • Authorization URL:
  • Scopes:
  • all:manage: View & Manage your BombBomb information
  • all:read: View your BombBomb information
  • email:manage: View & Manage your BombBomb emails
  • email:read: View your BombBomb emails
  • video:manage: View & Manage your BombBomb videos
  • video:read: View your BombBomb videos
  • contact:manage: View & Manage your BombBomb contacts
  • contact:read: View your BombBomb contacts
  • curriculum:manage: View & Manage your BombBomb challenges
  • curriculum:read: View your BombBomb challenges
  • automation:manage: View & Manage your BombBomb automations
  • automation:read: View your BombBomb automations
  • form:manage: View & Manage your BombBomb forms
  • form:read: View your BombBomb forms
  • list:manage: View & Manage your BombBomb lists
  • team:manage: View & Manage your BombBomb teams
  • team:read: View your BombBomb teams
  • order:manage: Manage your BombBomb orders
  • settings:manage: Manage your BombBomb settings
  • file:manage: View & Manage your BombBomb files
  • file:read: View your BombBomb files
  • account:manage: View & Manage your BombBomb account
  • account:read: View your BombBomb account