List effects

List the iMessage send effects accepted by effect on /send-api-message. Each entry has a name, type (bubble or screen), and a short description.

GET/get-effectsBearer token

Bubble effects: slam, loud, gentle, invisible-ink. Screen effects: confetti, balloons, hearts, lasers, fireworks, echo, spotlight, shooting-star, celebration. Not available on trial accounts.

Request

curl -X GET https://api.tryprojectblue.com/get-effects \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

200 OK

{
  "effects": [
    { "name": "slam", "type": "bubble", "description": "Slams the bubble onto the screen" },
    { "name": "loud", "type": "bubble", "description": "Enlarges the bubble, then shrinks it" },
    { "name": "gentle", "type": "bubble", "description": "Shrinks the bubble, then grows it" },
    { "name": "invisible-ink", "type": "bubble", "description": "Hides the message until the recipient swipes" },
    { "name": "confetti", "type": "screen", "description": "Full-screen confetti" },
    { "name": "balloons", "type": "screen", "description": "Full-screen balloons" },
    { "name": "hearts", "type": "screen", "description": "Full-screen hearts" },
    { "name": "lasers", "type": "screen", "description": "Full-screen lasers" },
    { "name": "fireworks", "type": "screen", "description": "Full-screen fireworks" },
    { "name": "echo", "type": "screen", "description": "Echoes the message across the screen" },
    { "name": "spotlight", "type": "screen", "description": "Spotlights the message" },
    { "name": "shooting-star", "type": "screen", "description": "Full-screen shooting star" },
    { "name": "celebration", "type": "screen", "description": "Full-screen celebration sparkles" }
  ]
}