Reaching the site's users: push notifications, newsletters, automations and QR codes.
Endpoints that need a token: the site owner creates it in their admin (Developers > API reference). AI assistants: how to ask the user for one.
28 endpoints in 7 parts: Advertisment, Alert, Automation, Connected Account, Instagram, Push Notification, Push Token.
Creates an ad from the fields sent.
Needs a site admin token.
curl -X POST 'http://builderly.max-media.io/ads?ionic=true' \ -H 'Authorization: Bearer <TOKEN>'
{
"name": "Example",
"media": "6543210fedcba98765432100",
"alt": "example",
"link": "example-item",
"_id": "6543210fedcba98765432100",
"updatedAt": "2026-11-04T12:00:00.000Z",
"createdAt": "2026-11-04T12:00:00.000Z"
}Returns one ad, found by its ID.
Needs a site admin token.
The ID of the ad.
curl -X GET 'http://builderly.max-media.io/ads/{id}?ionic=true' \
-H 'Authorization: Bearer <TOKEN>'{
"name": "Example",
"media": "6543210fedcba98765432100",
"alt": "example",
"link": "example-item",
"_id": "6543210fedcba98765432100",
"updatedAt": "2026-11-04T12:00:00.000Z",
"createdAt": "2026-11-04T12:00:00.000Z"
}Changes the fields sent; the others stay as they are.
Needs a site admin token.
The ID of the ad.
curl -X PATCH 'http://builderly.max-media.io/ads/{id}?ionic=true' \
-H 'Authorization: Bearer <TOKEN>'{
"name": "Example",
"media": "6543210fedcba98765432100",
"alt": "example",
"link": "example-item",
"_id": "6543210fedcba98765432100",
"updatedAt": "2026-11-04T12:00:00.000Z",
"createdAt": "2026-11-04T12:00:00.000Z"
}Deletes the ad. This cannot be undone.
Needs a site admin token.
The ID of the ad.
Returns an empty answer on success.
curl -X DELETE 'http://builderly.max-media.io/ads/{id}?ionic=true' \
-H 'Authorization: Bearer <TOKEN>'Returns the site's alerts, newest first unless a sort is given.
Needs a site admin token.
Returns a list of Alert objects.
curl -X GET 'http://builderly.max-media.io/alerts?ionic=true' \ -H 'Authorization: Bearer <TOKEN>'
[
{
"type": "example",
"heading": "Example",
"message": "example",
"meta_id": "6543210fedcba98765432100",
"_id": "6543210fedcba98765432100",
"updatedAt": "2026-11-04T12:00:00.000Z",
"createdAt": "2026-11-04T12:00:00.000Z"
}
]curl -X POST 'http://builderly.max-media.io/alerts?ionic=true' \ -H 'Authorization: Bearer <TOKEN>'
Returns one alert, found by its ID.
Needs a site admin token.
The ID of the alert.
Returns the Alert object.
curl -X GET 'http://builderly.max-media.io/alerts/{id}?ionic=true' \
-H 'Authorization: Bearer <TOKEN>'{
"type": "example",
"heading": "Example",
"message": "example",
"meta_id": "6543210fedcba98765432100",
"_id": "6543210fedcba98765432100",
"updatedAt": "2026-11-04T12:00:00.000Z",
"createdAt": "2026-11-04T12:00:00.000Z"
}Returns the site's automations, newest first unless a sort is given.
Needs a site admin token.
Returns a list of Automation objects.
curl -X GET 'http://builderly.max-media.io/automations?ionic=true' \ -H 'Authorization: Bearer <TOKEN>'
[
{
"title": "Example",
"webhook_url": "example-item",
"event_type": "example",
"_id": "6543210fedcba98765432100",
"updatedAt": "2026-11-04T12:00:00.000Z",
"createdAt": "2026-11-04T12:00:00.000Z"
}
]Creates an automation from the fields sent.
Needs a site admin token.
Returns the Automation object.
curl -X POST 'http://builderly.max-media.io/automations?ionic=true' \ -H 'Authorization: Bearer <TOKEN>'
{
"title": "Example",
"webhook_url": "example-item",
"event_type": "example",
"_id": "6543210fedcba98765432100",
"updatedAt": "2026-11-04T12:00:00.000Z",
"createdAt": "2026-11-04T12:00:00.000Z"
}Returns one automation, found by its ID.
Needs a site admin token.
The ID of the automation.
Returns the Automation object.
curl -X GET 'http://builderly.max-media.io/automations/{id}?ionic=true' \
-H 'Authorization: Bearer <TOKEN>'{
"title": "Example",
"webhook_url": "example-item",
"event_type": "example",
"_id": "6543210fedcba98765432100",
"updatedAt": "2026-11-04T12:00:00.000Z",
"createdAt": "2026-11-04T12:00:00.000Z"
}Changes the fields sent; the others stay as they are.
Needs a site admin token.
The ID of the automation.
Returns the Automation object.
curl -X PATCH 'http://builderly.max-media.io/automations/{id}?ionic=true' \
-H 'Authorization: Bearer <TOKEN>'{
"title": "Example",
"webhook_url": "example-item",
"event_type": "example",
"_id": "6543210fedcba98765432100",
"updatedAt": "2026-11-04T12:00:00.000Z",
"createdAt": "2026-11-04T12:00:00.000Z"
}Deletes the automation. This cannot be undone.
Needs a site admin token.
The ID of the automation.
Returns an empty answer on success.
curl -X DELETE 'http://builderly.max-media.io/automations/{id}?ionic=true' \
-H 'Authorization: Bearer <TOKEN>'Returns the site's models, newest first unless a sort is given.
Needs a site admin token.
The model's model.
curl -X GET 'http://builderly.max-media.io/get-model/{model}?ionic=true' \
-H 'Authorization: Bearer <TOKEN>'Returns the site's connected accounts, newest first unless a sort is given.
Needs the token of a signed-in user.
Returns a list of ConnectedAccount objects.
curl -X GET 'http://builderly.max-media.io/connected-accounts?ionic=true' \ -H 'Authorization: Bearer <TOKEN>'
[
{
"on_behalf_of": "6543210fedcba98765432100",
"user_account": "6543210fedcba98765432100",
"status": "pending",
"_id": "6543210fedcba98765432100",
"updatedAt": "2026-11-04T12:00:00.000Z",
"createdAt": "2026-11-04T12:00:00.000Z",
"is_authorized_to": {
"create_posts": false,
"send_messages": false,
"answer_delete_comments": false,
"access_engagements": false,
"access_boosted_posts": false,
"access_analytics": false,
"alter_profile_settings": false
}
}
]Returns one connected accounts on behalf of, found by its ID.
Needs the token of a signed-in user.
The ID of the connected accounts on behalf of.
curl -X GET 'http://builderly.max-media.io/connected-accounts-by-on-behalf-of/{id}?ionic=true' \
-H 'Authorization: Bearer <TOKEN>'{
"on_behalf_of": "6543210fedcba98765432100",
"user_account": "6543210fedcba98765432100",
"status": "pending",
"_id": "6543210fedcba98765432100",
"updatedAt": "2026-11-04T12:00:00.000Z",
"createdAt": "2026-11-04T12:00:00.000Z",
"is_authorized_to": {
"create_posts": false,
"send_messages": false,
"answer_delete_comments": false,
"access_engagements": false,
"access_boosted_posts": false,
"access_analytics": false,
"alter_profile_settings": false
}
}Returns one connected accounts on behalf of, found by its ID.
Needs the token of a signed-in user.
The ID of the connected accounts on behalf of.
curl -X GET 'http://builderly.max-media.io/connected-accounts-on-behalf-of/{id}?ionic=true' \
-H 'Authorization: Bearer <TOKEN>'{
"on_behalf_of": "6543210fedcba98765432100",
"user_account": "6543210fedcba98765432100",
"status": "pending",
"_id": "6543210fedcba98765432100",
"updatedAt": "2026-11-04T12:00:00.000Z",
"createdAt": "2026-11-04T12:00:00.000Z",
"is_authorized_to": {
"create_posts": false,
"send_messages": false,
"answer_delete_comments": false,
"access_engagements": false,
"access_boosted_posts": false,
"access_analytics": false,
"alter_profile_settings": false
}
}Update ConnectedAccount by id.
Needs the token of a signed-in user.
The ID of the connected account.
Returns the ConnectedAccount object.
curl -X PATCH 'http://builderly.max-media.io/connected-accounts-status/{id}?ionic=true' \
-H 'Authorization: Bearer <TOKEN>'{
"on_behalf_of": "6543210fedcba98765432100",
"user_account": "6543210fedcba98765432100",
"status": "pending",
"_id": "6543210fedcba98765432100",
"updatedAt": "2026-11-04T12:00:00.000Z",
"createdAt": "2026-11-04T12:00:00.000Z",
"is_authorized_to": {
"create_posts": false,
"send_messages": false,
"answer_delete_comments": false,
"access_engagements": false,
"access_boosted_posts": false,
"access_analytics": false,
"alter_profile_settings": false
}
}Returns one connected account, found by its ID.
Needs the token of a signed-in user.
The ID of the connected account.
Returns the ConnectedAccount object.
curl -X GET 'http://builderly.max-media.io/connected-accounts/{id}?ionic=true' \
-H 'Authorization: Bearer <TOKEN>'{
"on_behalf_of": "6543210fedcba98765432100",
"user_account": "6543210fedcba98765432100",
"status": "pending",
"_id": "6543210fedcba98765432100",
"updatedAt": "2026-11-04T12:00:00.000Z",
"createdAt": "2026-11-04T12:00:00.000Z",
"is_authorized_to": {
"create_posts": false,
"send_messages": false,
"answer_delete_comments": false,
"access_engagements": false,
"access_boosted_posts": false,
"access_analytics": false,
"alter_profile_settings": false
}
}Update ConnectedAccount by id.
Needs the token of a signed-in user.
The ID of the connected account.
Returns the ConnectedAccount object.
curl -X PATCH 'http://builderly.max-media.io/connected-accounts/{id}?ionic=true' \
-H 'Authorization: Bearer <TOKEN>'{
"on_behalf_of": "6543210fedcba98765432100",
"user_account": "6543210fedcba98765432100",
"status": "pending",
"_id": "6543210fedcba98765432100",
"updatedAt": "2026-11-04T12:00:00.000Z",
"createdAt": "2026-11-04T12:00:00.000Z",
"is_authorized_to": {
"create_posts": false,
"send_messages": false,
"answer_delete_comments": false,
"access_engagements": false,
"access_boosted_posts": false,
"access_analytics": false,
"alter_profile_settings": false
}
}Delete ConnectedAccount record by id.
Needs the token of a signed-in user.
The ID of the connected account.
Returns an empty answer on success.
curl -X DELETE 'http://builderly.max-media.io/connected-accounts/{id}?ionic=true' \
-H 'Authorization: Bearer <TOKEN>'Returns the site's connected accounts, newest first unless a sort is given.
Needs the token of a signed-in user.
Returns a list of ConnectedAccount objects.
curl -X GET 'http://builderly.max-media.io/my-connected-accounts?ionic=true' \ -H 'Authorization: Bearer <TOKEN>'
[
{
"on_behalf_of": "6543210fedcba98765432100",
"user_account": "6543210fedcba98765432100",
"status": "pending",
"_id": "6543210fedcba98765432100",
"updatedAt": "2026-11-04T12:00:00.000Z",
"createdAt": "2026-11-04T12:00:00.000Z",
"is_authorized_to": {
"create_posts": false,
"send_messages": false,
"answer_delete_comments": false,
"access_engagements": false,
"access_boosted_posts": false,
"access_analytics": false,
"alter_profile_settings": false
}
}
]Send an account connection request.
Needs the token of a signed-in user.
An email address.
curl -X POST 'http://builderly.max-media.io/send-account-connection-request?ionic=true' \
-H 'Authorization: Bearer <TOKEN>' \
-H 'Content-Type: application/json' \
-d '{ "email": "..." }'{
"name": "Example",
"email": "jane@example.com",
"avatar": "6543210fedcba98765432100",
"social_avatar": "example",
"isAdmin": false,
"isStaff": false,
"owner_id": "6543210fedcba98765432100",
"organization_name": "Example",
"firstname": "Example",
"lastname": "Example",
"phone_number": "+359 888 123 456",
"address": "example",
"city": "example",
"state": "example",
"country": "example",
"zip_code": "example",
"tax_identification_number": "example",
"notes": "Text shown on the site.",
"isConfirmed": false,
"number_of_sales": 0,
"stripe_id": "example",
"paypal_id": "example",
"access_level": 1,
"validation_code": "example",
"can_edit": {
"site": false,
"crm": false,
"store": false,
"payments": false,
"staff": false
},
"ip_location": {
"city": "example",
"continent_name": "Example",
"country_name": "Example",
"country_subdivision": "example",
"location_latitude": 0,
"location_longitude": 0,
"last_updated": "example"
}
}Returns the instagram.
Public - no token needed.
Only instagrams with this profile.
Only instagrams with this first.
curl -X GET 'http://builderly.max-media.io/get-instagram?ionic=true&profile=...&first=...'
Create new PushNotification.
Needs a site admin token.
The push notification's title.
The push notification's body.
The push notification's image.
The push notification's send to.
The push notification's type.
The push notification's URL slug, as in its address on the site.
Returns the PushNotification object.
curl -X POST 'http://builderly.max-media.io/push-notification?ionic=true' \
-H 'Authorization: Bearer <TOKEN>' \
-H 'Content-Type: application/json' \
-d '{ "title": "...", "body": "...", "image": "...", "sendTo": "...", "type": "..." }'{
"title": "Example",
"body": "Text shown on the site.",
"image": "example",
"send_to": "example",
"type": "example",
"_id": "6543210fedcba98765432100",
"updatedAt": "2026-11-04T12:00:00.000Z",
"createdAt": "2026-11-04T12:00:00.000Z"
}Get a summary info of push notifications.
Needs a site admin token.
curl -X GET 'http://builderly.max-media.io/push-notification-info?ionic=true' \ -H 'Authorization: Bearer <TOKEN>'
{
"user": "example",
"is_admin": false,
"_id": "6543210fedcba98765432100",
"updatedAt": "2026-11-04T12:00:00.000Z",
"createdAt": "2026-11-04T12:00:00.000Z"
}Returns the push notification.
Needs a site admin token.
Only push notifications with this send to.
Returns the PushNotification object.
curl -X GET 'http://builderly.max-media.io/push-notification/timer?ionic=true&sendTo=...' \ -H 'Authorization: Bearer <TOKEN>'
{
"title": "Example",
"body": "Text shown on the site.",
"image": "example",
"send_to": "example",
"type": "example",
"_id": "6543210fedcba98765432100",
"updatedAt": "2026-11-04T12:00:00.000Z",
"createdAt": "2026-11-04T12:00:00.000Z"
}Returns the push token.
Needs a site admin token.
Returns the PushToken object.
curl -X GET 'http://builderly.max-media.io/push-token?ionic=true' \ -H 'Authorization: Bearer <TOKEN>'
{
"user": "example",
"is_admin": false,
"_id": "6543210fedcba98765432100",
"updatedAt": "2026-11-04T12:00:00.000Z",
"createdAt": "2026-11-04T12:00:00.000Z"
}Returns one push token, found by its ID.
Needs a site admin token.
The ID of the push token.
Returns the PushToken object.
curl -X GET 'http://builderly.max-media.io/push-token/{id}?ionic=true' \
-H 'Authorization: Bearer <TOKEN>'{
"user": "example",
"is_admin": false,
"_id": "6543210fedcba98765432100",
"updatedAt": "2026-11-04T12:00:00.000Z",
"createdAt": "2026-11-04T12:00:00.000Z"
}