Start a keyless test project
Send Sendly's free test emails to your OWN inbox with no account and no API key.
Answers a test project, a pk_test_ key holding only emails:test (shown once, here), and mails a 6-digit code to email. Confirm the code with POST /api/v1/keyless/verify; from then on POST /api/v1/emails/test with the same key reaches that address and no other, until the free test emails are used up. claim_url lets a person adopt the project into a real account.
The first call answers 428 proof_required: details carries a challenge and the number of leading zero bits (difficultyBits) a SHA-256 of <challenge>:<nonce> must have, plus ready-to-run solvers in details.howTo. Send the same request again with the header Sendly-Keyless-Proof: <challenge>:<nonce>. A challenge lasts 5 minutes and works once.
Limits: 3 starts per address and 5 per network a day, and a global daily ceiling. Sandbox, disposable and role addresses (info@, admin@, …) are refused.
Sendly-Keyless-Proof?string<challenge>:<nonce> — the solved proof of work from a 428 answer.
length <= 256application/json- body
Body for POST /api/v1/keyless/start.
email*stringThe address the code is mailed to, and the ONLY address this project's test emails can then reach. Disposable and role addresses are refused.
emaillength <= 254Test project created and the code mailed
application/json- response
A keyless test project, started.
key*stringThe keyless key (pk_test_...), shown ONCE. It can only send test emails, through POST /api/v1/emails/test, to the confirmed address, and call the keyless routes. Every other endpoint refuses it.
project_id*stringThe keyless test project.
uuidemail*stringThe address the code was sent to, lower-cased.
emailverified*falseAlways false here: the address is confirmed by the code.
falsecode_expires_at*stringWhen the code stops working (15 minutes).
date-timetest_allowance*Where the project stands against its free test emails.
claim_url*stringWhere a person claims this test project into a free account. The key rides in the URL fragment, which a browser never sends to a server.
urinext*The next step.
curl -X POST 'https://api.sendly.now/api/v1/keyless/start' \ -H 'Content-Type: application/json' \ -d '{ "email": "user@example.com"}'{ "key": "string", "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9", "email": "user@example.com", "verified": false, "code_expires_at": "2019-08-24T14:15:22Z", "test_allowance": { "limit": 0, "used": 0, "remaining": 0 }, "claim_url": "http://example.com", "next": { "call": "string", "say": "string" }}