Getting Started

The Flashy API is a REST API served at:

https://api.flashy.app

Before you can use the API, you must verify your Flashy account.

Authentication

Your account API key must be included in every request. You can send it in a few ways — choose the best one for you:

• As a request header named x-api-key — most recommended.
• On GET requests, as the query parameter key=your_account_key.
• On requests with a body, as a key property in the request body.

curl https://api.flashy.app/account \
  -H "x-api-key: YOUR_API_KEY"

You can find your API key in your Flashy dashboard under account settings.

The response envelope

Every response is JSON with the same envelope: success tells you whether the call worked, and data carries the result (or null for write operations that return nothing).

{
    "success": true,
    "data": {
        "id": 83,
        "account": "r33piu",
        "name": "My Account"
    }
}

Your first request: create a contact

Contacts are the foundation of the Flashy platform. Create one (or upsert with overwrite) like this:

curl -X POST https://api.flashy.app/contact \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "primary_key": "email",
    "overwrite": false,
    "contact": {
        "email": "user1@name.com",
        "first_name": "Rafael",
        "lists": { "159": true }
    }
  }'

The lists object subscribes the contact to lists: the key is the List ID and the value is true if the contact is marketing-eligible. Get your list IDs from GET /lists.

PHP SDK

If you are using PHP we have a ready SDK wrapper — PHP SDK.

Next steps

• Browse the full API Reference — every endpoint with examples and a try-it console.
• Receive real-time notifications with Webhooks.
• Track contact activity and trigger automations with Events.