Skip to content
Sign In
  • There are no suggestions because the search field is empty.

Open API and Custom Integrations explained

In this article, we discuss the betterbunch Open API and how to setup a connection

If you're using specialised or custom-built job management or invoicing software, our Open API makes your life easier by helping automate the invitation creation process.

What is Open API and Custom Integrations? 

The betterbunch Open API is a set of rules and guidelines that allows different software platforms to communicate with betterbunch.

Using Open API, a Software Developer or someone familiar with software coding can link your CRM with betterbunch, enabling your CRM to generate betterbunch invitations automatically on your behalf.

Your developers can follow the documentation and code below to make this connection. 

Once the custom integration is active, whenever a defined trigger (such as a completed job) is met within your CRM, betterbunch will receive the customer details you provide and use them to create an invitation automatically.

An email address or mobile number is required to create an invitation, while the customer’s name is optional.

Tip: Check out this list of platforms betterbunch integrates with. Consider using pre-existing integrations, rather than building a custom integration.

Note: The betterbunch Open API is managed and maintained by betterbunch Developers. A custom integration between your software and betterbunch must be built and managed by your technical team.

We're happy to work alongside you, but your team will remain responsible for the development and maintenance of the custom integration and Open API code.

Creating Invitations Endpoints 

This section discusses the technical aspects of setting up your custom integration. To successfully implement this, you will require developer access to your CRM and a foundational knowledge of coding.

Create an invitation for the user. Uses x-api-key HTTP header for authentication.

POST: https://api.betterbunch.com/openapi/invitations

Learn how to find your Open API Key here. 

HTTP HEADERS

X_API_KEY

string  Required

x-api-key

JSON PARAMETERS

name

string Optional

Customers 's first name.

scott

email

string Optional

Customer's email address.

[email protected]

phoneNumber

string Optional 

+64226783719

Note: At least one valid email address or phone number must be provided. If neither is supplied, the request will be rejected with a 400 response. 

sendDate

Datetime Optional 

The date and time you want the invitation to send, using the timezone set on the betterbunch account.

If sendDate is not provided, the invitation will follow the Open API send schedule configured for the account. If no Open API send schedule has been set, the invitation will be sent straight away.

2026-08-29T02:16:54

sendFollowUp

boolean Optional

Controls whether a promoter retargeting email can be sent after the invitation.

  • Set to true to send a promoter retargeting email when the customer is eligible.
  • Set to false to prevent a promoter retargeting email from being sent.
  • If this parameter is left out, the account’s promoter retargeting setting will be used.

The retargeting email is sent 3 days after the original invitation, and only if the customer gave positive feedback, did not proceed to leave a review, and has a valid email address.

ignoreCoolOffPeriod

boolean Optional 

Default false

The cool-off period prevents the same customer from receiving invitations too often. The period is configured in the betterbunch account and is 180 days by default.

When set to false, an invitation will not be created if the customer has already received an invitation within the cool-off period or currently has an invitation waiting to send. The API will return a 200 response with the reason cool_off_period.

When set to true, the cool-off period is ignored and the invitation will be created.

RESPONSES

201

Invitation created

The invitation was successfully created and the response includes the invitation ID.

A 201 response confirms that the invitation was created, but does not always mean a message will be sent. For example, if the customer is blocklisted or has unsubscribed, the invitation will be created and then immediately closed without sending.

200

Cool-off period 

The invitation was not created because the customer is within the account’s cool-off period or already has an invitation waiting to send. The response will include the reason cool_off_period.

400

The request could not be processed. This can happen when:

  • neither an email address nor phone number has been provided
  • the email address is invalid
  • the phone number is invalid
401

Not authorised 

The API key is missing or is not authorised. 

500

Unexpected error

An unexpected error occurred while processing the request.

Tip: Once your custom integration is live, we recommend sending a test invitation to make sure everything is working as expected.

Note: Open API activity does not appear in Automation Logs. You can check invitations created through the API from your Invitations list, where the source will be shown as Open API.