MaillyDocs

Resume setup with its private setup token

GET
/onboarding/{id}/status

Authorization: Bearer <setup_token> only permits checking this setup. 202 before human confirmation; 200 ready returns the mailbox address and the account API key the human approved handing to the agent. Store the key in secure credential storage and never show it in chat or logs. Ready status can be retried for 10 minutes after confirmation.

Path Parameters

id*string
Formatuuid

Response Body

Ready (with the API key) or denied

application/json
  1. response
success*boolean
status*string
Value in"ready""denied"
address?
api_key?string
hint?string
[key: string]?unknown
curl -X GET 'https://api.mailly.site/onboarding/497f6eca-6276-4993-bfeb-53cbbbba6f08/status'
{  "success": true,  "status": "ready",  "address": {    "id": "string",    "address": "string"  },  "api_key": "string",  "hint": "string",  "property1": null,  "property2": null}