Errors

Every error the API returns carries a code and a docs_url pointing here. Each page says what the error means, why it happens and how to fix it.

400bad_requestSomething in the request itself is wrong: a query parameter, a header or the body. Change the request and send it again.
400invalid_versionThe Commune-Version header names a contract version this API does not serve. Send one from allowed_values, or leave the header out.
401unauthorizedThe request carried no credential the API accepts: none at all, a malformed one, or one that is unknown, revoked or expired.
403forbiddenThe credential is valid but cannot act on the newsletter you addressed, or on the key you tried to revoke.
403insufficient_scopeThe credential reaches the newsletter but does not hold the permission this operation, filter or expansion needs.
402payment_requiredThe credential may do this, but the newsletter's Commune plan does not include it. Reads outside insights stay free.
404not_foundNothing this credential may see exists at that identifier. It may not exist at all, or your credential may not be allowed to know it does.
409conflictThe Idempotency-Key on this write was already used for a different request, or a request with the same key has not finished.
422unprocessableThe request is well formed, and the current state of what it addresses refuses it. The message says what is in the way.
422not_commune_newsletterArticles can only be created or edited on a newsletter Commune publishes itself, one whose esp is commune.
429rate_limitedA rate limit budget or a daily send limit is spent. Wait Retry-After seconds; the message names which limit it was.
500internal_errorSomething failed inside Commune. Retry with backoff, reusing the same Idempotency-Key for a write, and quote the request id if it persists.
503service_unavailableA service this one operation depends on did not answer. The rest of the API is unaffected; retry this operation after Retry-After.