Skip to content
Insy
For developers
Esc
↑↓navigate↵open⌘Jpreview

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
slotsnumber | nullrequired
Total number of slots (null if unlimited)
slotsUsednumberrequired
Number of slots already used
availableSlotsnumber | nullrequired
Available slots (null if unlimited)
startsAtstringrequired
When the drop slot starts (ISO string)
endsAtstring | nullrequired
When the drop slot ends (ISO string, null if no end date)
isCurrentlyActivebooleanrequired
Whether the drop is currently active (started and not ended)
dropNotificationDropNotification | anyrequired
Drop notification
Show properties
Any of:
DropNotification
communityobjectrequired
smsMessagestringrequired
activebooleanrequired
default: true
dropSlotsobject
dropNotificationUsersobjectrequired
idstringrequired
createdAtstring<date-time>required
default: "2026-10-17T20:51:49.186Z"
updatedAtstring<date-time>required
default: "2026-10-17T20:51:49.186Z"
any
any
userHasNotificationboolean
Whether the user has a notification for this drop slot
401Invalid, expired, or revoked API key
403Insufficient API key permissions
Try it
Server
Authorization
Bodyapplication/json
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"
}'
Response
{
  "success": true,
  "errorCode": "not_found",
  "message": "Success",
  "data": {
    "signedUp": true,
    "hasExistingAccount": true,
    "dropSlotInfo": {
      "id": "string",
      "slots": 0,
      "slotsUsed": 0,
      "availableSlots": 0,
      "startsAt": "string",
      "endsAt": "string",
      "isCurrentlyActive": true,
      "dropNotification": {
        "community": {},
        "smsMessage": "string",
        "active": true,
        "dropSlots": {},
        "dropNotificationUsers": {},
        "id": "string",
        "createdAt": "2026-10-17T20:51:49.186Z",
        "updatedAt": "2026-10-17T20:51:49.186Z"
      },
      "userHasNotification": true
    }
  }
}