Skip to the documentation
CLI

nextmail shared

Every command in this namespace, with its arguments, flags and examples.

Commands

Templates, forms and automations shared at a public link by any workspace: read what the page of a link shows, from the token at its end, and copy the item into this workspace as a new draft when its owner lets people copy it.

Every command here also takes the global flags, such as --json, --profile and --dry-run. See the global flags

nextmail shared get

Read a template, form or automation shared at a public link

Scopestemplates:readNeeds a sign-inAliasesshowview

Usage

nextmail shared get <token> [flags]

Resolves with what the public page of a link shows, from any workspace, this one included: the name and description of the item, the name of the workspace that shares it, whether it may be copied, and its content. Of template, form and automation, the one kind names is set and the other two are null.

A template comes rendered with the sample values of its props, as subject, html and text, and unfilled names the props and slots that have no sample value, so they render empty. A form comes with its design and whether it asks people to confirm their address. An automation comes with its flow, its settings and the template each send step sends. The audiences, addresses, forms and webhook endpoints an automation points at are left empty, and the audience choices of a form keep their labels only, because those belong to the owner.

Reading it here does not count as a view of the page.

Arguments

<token>Required

The token at the end of the public link: token on a ShareLinkResource, or the last part of its url.

Examples

nextmail shared get 9c4e2a7f1b6d3e8a0f5c2b7d4e1a9f36
Print the raw JSON
nextmail shared get 9c4e2a7f1b6d3e8a0f5c2b7d4e1a9f36 --json

Also available in

API
GET /shared/{token}
TypeScript
shared.get()
Python
shared.get()
Ruby
shared.get
PHP
shared->get
Go
Shared.Get
Java
shared().get
C#
Shared.GetAsync

nextmail shared copy

Copy a shared template, form or automation into this workspace

Scopestemplates:writeNeeds a sign-in

Usage

nextmail shared copy <token> [flags]

Copies the item at a public link into this workspace as a new draft, as Copy to my workspace does on the page, and resolves with the copy. The copy counts in copies on the link, and it is an item of its own, so later changes on either side never reach the other.

A template whose name is taken here gets a number after it, and the images it shows are copied into this workspace. An automation brings the templates its send steps send, copied as new templates and listed in templateIds, and its steps send those copies.

A copy carries the design only: never the submissions, sends, runs or contacts the original collected, and never the audiences, addresses, forms or webhook endpoints it points at. Those stay with the owner and are left empty for you to fill in.

Arguments

<token>Required

The token at the end of the public link: token on a ShareLinkResource, or the last part of its url.

Examples

nextmail shared copy 9c4e2a7f1b6d3e8a0f5c2b7d4e1a9f36
Print the raw JSON
nextmail shared copy 9c4e2a7f1b6d3e8a0f5c2b7d4e1a9f36 --json

Also available in

API
POST /shared/{token}/copy
TypeScript
shared.copy()
Python
shared.copy()
Ruby
shared.copy
PHP
shared->copy
Go
Shared.Copy
Java
shared().copy
C#
Shared.CopyAsync