documenter.getpostman.com Open in urlscan Pro
2606:4700:4400::6812:2196  Public Scan

Form analysis
0 forms found in the DOM

Text Content

 * Body
 * Headers (0)




Public


Documentation Settings

ENVIRONMENT
No Environment

LAYOUT
Double Column

LANGUAGE
cURL - cURL



Onespot API
Introduction
POST
Send User Invitations


ONESPOT API


WELCOME TO ONESPOT'S BRAND NEW API!

It's so new, in fact, that we only have one public-facing endpoint so far...

If you have questions or run into any issues, reach out Sean:
sean@seabirdapps.com. He's our head developer, so any issues are definitely his
fault he can probably help you out 🙂

Make sure to include apiKey in the body of every request. And if you don't yet
have an API key, you know who to reach out to.

Have fun! And let us know your feedback.





POSTSEND USER INVITATIONS

https://us-central1-seabirdmain.cloudfunctions.net/api/onespot-send-user-invitations

This sends out emails to a list of contacts inviting them to join your app.

If the request fails, make sure to check the response as it might include a
helpful error message.

Please don't send to more than ~50 contacts at a time.

Here's what an example email invitation looks like:



Here's an example response:

View More
json


{
    "status": "success",
    "message": "Process completed. 1 invitations sent, 1 existing users updated, 1 invitations skipped.",
    "invitationsSent": ["sean@seabirdapps.com"],
    "updatedUsers": ["sean+1@seabirdapps.com"],
    "skippedInvitations": ["sean+2@seabirdapps.com"]
}

Bodyraw (json)
View More
json


{
    // Always include your API key
    "apiKey": "ABC123",
    // ID of your app. This can be found in your web app's URL
    "appID": "-Nd0wYVIAG0Ar00AB2js",
    // Your web app's URL
    "webLink": "https://1spot.app/?app=-Nd0wYVIAG0Ar00AB2js",
    // Your name (or your organization's name)
    "senderName": "Uphill New England",
    // If the recipient replies to their invitation email, this is who will receive the reply
    "senderEmail": "info@uphillnewengland.org",
    // List of contacts to send invitations to
    "contacts": [
        {
            // Email to send the first invitation to
            "email": "sean@seabirdapps.com",
            // Optional
            "firstName": "Sean",
            // Optional
            "lastName": "Cann",
            // Optional
            "phoneNumber": "123-456-7890"
        }
    ],
    // Required for standalone apps: The name & links to your app in the app stores
    "appStoreInfo": {
        "appName": "Uphill New England",
        "appLinks": {
            "ios": "https://apps.apple.com/us/app/uphill-new-england/id6465691357",
            "android": "https://play.google.com/store/apps/details?id=com.seabirdapps.uphillnewengland"
        }
    },
    // Optional: You can pre-configure some account information for invitees who sign up
    // Note: If the user you're inviting already has an account, any fields specified here will overwrite the corresponding field in their existing account. For example, you can automatically update their account type this way.
    "account": {
        // (Optional) ID of the account type that users will be assigned to when they sign up via your invitation
        "type": "member",
        // (Optional) Any other custom account-related fields that have been configured for your app
        "age": "42",
        "gender": "Unicorn",
        "zipCode": "10025",
        // (Optional) The IDs of groups these users will be assigned to by default
        "groups": {
            "-aBcDeFgHiJkLmNoP123": true,
            "-zXyDeFgHiJkLmNoP456": true
        }
    },
    // Optional: Message included with the email invitation
    "message": "Welcome to Uphill New England! Get ready to ski up some slopes 🏔️",
    // Optional: Image included at the top of the invitation email
    "logoURL": "https://static.wixstatic.com/media/9a0de2_7036a968f06a41d08dc21d4002e5f34e~mv2.png/v1/fill/w_219,h_69,al_c,q_85,usm_0.66_1.00_0.01,enc_auto/UpNE%20LOGO%20-%20horiz%20blues_600px.png"
}

Example Request
Send User Invitations

View More
curl


curl --location 'https://us-central1-seabirdmain.cloudfunctions.net/api/onespot-send-user-invitations' \
--data-raw '{
    // Always include your API key
    "apiKey": "ABC123",
    // ID of your app. This can be found in your web app'\''s URL
    "appID": "-Nd0wYVIAG0Ar00AB2js",
    // Your web app'\''s URL
    "webLink": "https://1spot.app/?app=-Nd0wYVIAG0Ar00AB2js",
    // Your name (or your organization'\''s name)
    "senderName": "Uphill New England",
    // If the recipient replies to their invitation email, this is who will receive the reply
    "senderEmail": "info@uphillnewengland.org",
    // List of contacts to send invitations to
    "contacts": [
        {
            // Email to send the first invitation to
            "email": "sean@seabirdapps.com",
            // Optional
            "firstName": "Sean",
            // Optional
            "lastName": "Cann",
            // Optional
            "phoneNumber": "123-456-7890"
        }
    ],
    // Required for standalone apps: The name & links to your app in the app stores
    "appStoreInfo": {
        "appName": "Uphill New England",
        "appLinks": {
            "ios": "https://apps.apple.com/us/app/uphill-new-england/id6465691357",
            "android": "https://play.google.com/store/apps/details?id=com.seabirdapps.uphillnewengland"
        }
    },
    // Optional: You can pre-configure some account information for invitees who sign up
    // Note: If the user you'\''re inviting already has an account, any fields specified here will overwrite the corresponding field in their existing account. For example, you can automatically update their account type this way.
    "account": {
        // (Optional) ID of the account type that users will be assigned to when they sign up via your invitation
        "type": "member",
        // (Optional) Any other custom account-related fields that have been configured for your app
        "age": "42",
        "gender": "Unicorn",
        "zipCode": "10025",
        // (Optional) The IDs of groups these users will be assigned to by default
        "groups": {
            "-aBcDeFgHiJkLmNoP123": true,
            "-zXyDeFgHiJkLmNoP456": true
        }
    },
    // Optional: Message included with the email invitation
    "message": "Welcome to Uphill New England! Get ready to ski up some slopes 🏔️",
    // Optional: Image included at the top of the invitation email
    "logoURL": "https://static.wixstatic.com/media/9a0de2_7036a968f06a41d08dc21d4002e5f34e~mv2.png/v1/fill/w_219,h_69,al_c,q_85,usm_0.66_1.00_0.01,enc_auto/UpNE%20LOGO%20-%20horiz%20blues_600px.png"
}'

Example Response
 * Body
 * Headers (0)

No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers