Guests

This page will help you retrieve, update, create or remove guest with the Beambox API

Retrieve All Guests

Use this endpoint to retrieve all your guests. By default, the response will be limited to 100 guests, you can include the limit and offset variables to make multiple requests if you have over 100 guests.

Replace YOUR_API_KEY_HERE with your Beambox API key. You can find this on the integrations page of your Beambox account.

HTTParty.get("https://beambox.com/api/v1/YOUR_API_KEY_HERE/guests", body: {limit: 2, offset: 0})
[
    {
        "id": 442221,
        "email": "[email protected]",
        "provider": "email",
        "fullname": "Callum Short",
        "gender": "Male",
        "subscribed": false,
        "device_type": "desktop",
        "birthday": "1997-05-15",
        "blocked": false,
        "country": null,
        "phone": null,
        "custom_data": {},
        "tags": [
            "26",
            "9",
            "3"
        ]
    },
    {
        "id": 452580,
        "email": "[email protected]",
        "provider": "email",
        "fullname": "Alan Stealey",
        "gender": null,
        "subscribed": true,
        "device_type": null,
        "birthday": "1964-03-08",
        "blocked": false,
        "country": null,
        "phone": null,
        "custom_data": {},
        "tags": []
    }
]

Retrieve A Guest

Use this endpoint to retrieve the details of a single guest. The Guests email is a required parameter.

Replace YOUR_API_KEY_HERE with your Beambox API key. You can find this on the integrations page of your Beambox account.

HTTParty.get("https://beambox.com/api/v1/YOUR_API_KEY_HERE/guest", body: {email: "[email protected]"})
{
    "id": 442221,
    "email": "[email protected]",
    "provider": "email",
    "fullname": "Callum Short",
    "gender": "Male",
    "subscribed": false,
    "device_type": "desktop",
    "birthday": "1997-05-15",
    "blocked": false,
    "country": null,
    "phone": null,
    "custom_data": {},
    "tags": [
        "26",
        "9",
        "3"
    ]
}

Update a Guest

Use this endpoint to update your guests data fields. Email is a required parameter. The following fields are optional, use the ones your wish to update. NOTE: You cannot update the guests email.

fullname, gender, subscribed, birthday, blocked, country, phone.

Replace YOUR_API_KEY_HERE with your Beambox API key. You can find this on the integrations page of your Beambox account.

HTTParty.patch("https://beambox.com/api/v1/YOUR_API_KEY_HERE/guest", body: {email: "[email protected]", fullname: "Cal Short"})
{
    "fullname": "Cal Short",
    "email": "[email protected]",
    "provider": "email",
    "id": 442221,
    "phone": null,
    "gender": "Male",
    "country": null,
    "custom_data": {},
    "subscribed": false,
    "device_type": "desktop",
    "birthday": "1997-05-15",
    "blocked": false,
    "tags": [
        "26",
        "9",
        "3"
    ],
    "updated_at": "2021-01-26T11:29:25.959+00:00"
}

Create New Guest

Use this endpoint to create a new guest. Email, fullname and location_id are required parameters. The following fields are optional, use the ones your wish to add to your guests profile.

gender, subscribed, birthday, blocked, country, phone.

Replace YOUR_API_KEY_HERE with your Beambox API key. You can find this on the integrations page of your Beambox account.

HTTParty.post("https://beambox.com/api/v1/YOUR_API_KEY_HERE/guest", body: {email: "[email protected]", fullname: "Joes Blogs", location_id: 7})
{
    "id": 981632,
    "email": "[email protected]",
    "provider": "import",
    "fullname": "Joe Bloggs",
    "gender": null,
    "subscribed": true,
    "device_type": null,
    "birthday": null,
    "blocked": false,
    "country": null,
    "phone": null,
    "custom_data": {},
    "tags": []
}

Remove a Guest

Use this endpoint to remove a guest from your guest database. Email is a required parameter.

Replace YOUR_API_KEY_HERE with your Beambox API key. You can find this on the integrations page of your Beambox account.

HTTParty.delete("https://beambox.com/api/v1/YOUR_API_KEY_HERE/guest", body: {email: "[email protected]"})