POST https://api.usecommune.com/newsletters/{newsletter}/portal-session Production. There is no separate sandbox host.

Open the event delivery portal

Mints a link into the delivery portal for this newsletter, where a creator adds a destination, disables one, rotates the secret its deliveries are signed with, and reads the response body an endpoint answered a failed delivery with. Needs webhooks: write.

This is the only way to create or edit a destination. There is no operation here that does it. The attempt log is readable through GET /newsletters/{newsletter}/delivery-attempts; what the portal has that this API does not is the response body an endpoint returned, which Commune withholds for the same reason it withholds a destination's configured request headers.

The returned url is a credential. It carries a bearer token in its query string, scoped to this newsletter, and anyone who opens it can change where this newsletter's events go. Redirect the person who asked for it and let the link be spent. Do not store it, log it, put it in a shared document or mail it; minting a new one is cheap.

Each call returns a different link, and nothing here can be fetched again afterwards. Takes no body and no parameters.

Path parameters

  • string Required

Request Headers

  • string
POST /newsletters/{newsletter}/portal-session
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-createportalsession

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.