Reset a sandbox inbox's SMTP credentials

POST/api/v1/sandbox/inboxes/{id}/reset-credentials
Requires anorganization API keywith the scopesandbox:write

Issues a new username and secret. The old ones stop working immediately, so update anything configured with them. Owners and admins only.

This endpoint takes no request body.

Parameters

NameInTypeDescription
idrequiredpathstringThe id identifier.

Request

POST/api/v1/sandbox/inboxes/{id}/reset-credentials
curl -X POST 'https://app.mailyte.com/api/v1/sandbox/inboxes/01JBT8XQ2M9WYC3K4F6R7S8T9V/reset-credentials' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'
The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

  • dataobject
    • usernamestring
    • secretstring

      The new SMTP password. The old one no longer works.

Returned inside the standard envelope.

Errors

StatusWhen
401The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist.
403The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys.
404No such resource in this organization.
422The request was understood but the values were not acceptable.
429Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait.

Every status, with what causes it and what to do, is on the error reference.