POST https://api.usecommune.com/articles/{article}/test-send Production. There is no separate sandbox host.

Send a test copy of an article

Sends this article to addresses you name, or to yourself when you name none, so somebody can look at it before the list does. Needs sending: write.

Leave out to (or the whole body) and the copy goes to the person the credential belongs to. Their address is not echoed back: the answer says sent_to_owner: true and recipients is empty, because an email address is revealed only by GET /me.

Nobody on the list receives anything. No subscriber is touched, no delivery is recorded, the article's status does not move and no event is published. Run it as often as you like on the same draft: it changes nothing about the article, so a repeat is a second look rather than a second send.

The article is rendered the way a real send renders it, with three differences. Personalization placeholders are filled with example data rather than left as raw text. The unsubscribe link points at a page that explains itself rather than at a live token, so a forwarded test cannot unsubscribe a real person. And the subject is prefixed, so a test is never mistaken for the article.

Three of the six send gates apply here. There has to be an article, a verified sending address, and something in the body. The footer required on commercial email, the article's status and the image reachability check do not refuse a test, so a test is where you go to see that the footer has gone. Send an article to the list (POST /articles/{article}/send) refuses on all six.

Test sends count towards the same daily sending allowance real sends do.

Path parameters

  • string Required

Request Headers

  • string
  • string Required

Body

  • array[string(email)]
POST /articles/{article}/test-send
Loading...

Share your request

Use this link to easily share a pre-filled request of this operation. Everything you filled will be shared apart from the authentication fields.

Request URL

https://api-reference.usecommune.dev/explorer/operation/operation-sendarticletest

Send a delete request

It looks like you’re about to send a DELETE request to this API. This type of request carries a risk of permanent and irreversible data loss.

Are you sure you want to continue?
Response
Waiting for a request to be sent.