Skip to Content
SendlySendly
API ReferenceKeyless

Confirm a keyless start's email

POST
/api/v1/keyless/verify

Confirm the address a keyless start mailed its code to. Bearer: the keyless key. A code lasts 15 minutes and allows 5 tries; confirming an already confirmed start answers success again.

Requires the emails:test scope — Send test emails to your own address from the Sendly sandbox.

headerAuthorizationBearer <API Key>

API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.

application/json
  1. body

Body for POST /api/v1/keyless/verify.

code*string

The 6-digit code Sendly emailed to the start's address.

Match^\d{6}$

Response Body

Address confirmed

application/json
  1. response

The keyless start's address, confirmed.

verified*true

The address is confirmed.

Value intrue
email*string

The confirmed address: the one test emails can reach.

Formatemail
test_allowance*

Where the project stands against its free test emails.

next*

The next step.

Example Request
curl -X POST 'https://api.sendly.now/api/v1/keyless/verify' \  -H 'Content-Type: application/json' \  -d '{  "code": "string"}'
Example Response
{  "verified": true,  "email": "user@example.com",  "test_allowance": {    "limit": 0,    "used": 0,    "remaining": 0  },  "next": {    "call": "string",    "say": "string"  }}