Sign up for drop notification with auto-detected upcoming slot

POST/api/drop-notification/signup

Authorization

AuthorizationBearer token (API Key) · headerrequired

API Key for programmatic access (format: insy_xxxxx)

Request body

requiredapplication/json

communityIdstring<uuid>required

The community ID for the drop notification

emailstring<email>required

Email address for drop notification

phoneNumberstring

Phone number for SMS notification

Responses

200Successful response

successbooleanrequired

Whether the request was successful

errorCodestringrequired

The error code returned by the request

Allowed:not_foundbad_requestalready_existsunauthorizedforbiddeninternal_server_errorservice_unavailabletimeoutconflictprecondition_failedunprocessable_entity

messagestringrequired

The message returned by the request

dataDropNotificationSignupResultObject

Show properties

signedUpbooleanrequired

Whether the signup was successful

hasExistingAccountboolean

Whether the provided email is already connected to a user account (only in public endpoint)

dropSlotInfoobject

Information about the nearest/upcoming drop slot

Show properties

idstringrequired

Drop slot ID

slotsobject | nullrequired

Total number of slots (null if unlimited)

slotsUsednumberrequired

Number of slots already used

availableSlotsobject | nullrequired

Available slots (null if unlimited)

startsAtstringrequired

When the drop slot starts (ISO string)

endsAtobject | nullrequired

When the drop slot ends (ISO string, null if no end date)

isCurrentlyActivebooleanrequired

Whether the drop is currently active (started and not ended)

dropNotificationobject | nullrequired

Drop notification

userHasNotificationboolean

Whether the user has a notification for this drop slot

401Invalid, expired, or revoked API key

403Insufficient API key permissions

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (API Key)Remember on this deviceInclude my values in samples

Bodyapplication/json

communityIdstring*The community ID for the drop notificationemailstring*Email address for drop notificationphoneNumberstringPhone number for SMS notification

Request

curl -X POST "https://api.insy.io/api/drop-notification/signup" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "communityId": "b3a7bb5e-2860-4aca-803b-cc380a8c5ca0",
  "email": "user@example.com",
  "phoneNumber": "+48123456789"
}'

const response = await fetch("https://api.insy.io/api/drop-notification/signup", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "communityId": "b3a7bb5e-2860-4aca-803b-cc380a8c5ca0",
  "email": "user@example.com",
  "phoneNumber": "+48123456789"
})
});

import requests

response = requests.post(
    "https://api.insy.io/api/drop-notification/signup",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "communityId": "b3a7bb5e-2860-4aca-803b-cc380a8c5ca0",
  "email": "user@example.com",
  "phoneNumber": "+48123456789"
},
)

Response

{
  "success": true,
  "errorCode": "not_found",
  "message": "Success",
  "data": {
    "signedUp": true,
    "hasExistingAccount": true,
    "dropSlotInfo": {
      "id": "string",
      "slots": {},
      "slotsUsed": 0,
      "availableSlots": {},
      "startsAt": "string",
      "endsAt": {},
      "isCurrentlyActive": true,
      "dropNotification": {},
      "userHasNotification": true
    }
  }
}