client.shared
Every method in this namespace: its signature, its parameters, what it returns and an example.
Methods
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.
shared.get
Read a template, form or automation shared at a public link
get(token, api_key: nil) -> HashReturns 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 nil.
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.
Parameters
tokenStringRequiredThe token at the end of the public link:
tokenon a link thatshare_links.listorshare_links.getreturns, or the last part of itsurl.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with object set to shared_item, kind, token, name, description, workspaceName, copyable, sharedAt, template, form and automation. template is a Hash with subject, engine, slots, props, html, text and unfilled, form a Hash with document and doubleOptIn, and automation a Hash with definition, templates and settings. workspaceName is empty when the workspace has no name, and sharedAt is when the item was made public at this link.
Example
item = client.shared.get("9c4e2a7f1b6d3e8a0f5c2b7d4e1a9f36") puts item[:kind], item[:name], item[:workspaceName], item[:copyable] template = item[:template]puts template[:subject], template[:unfilled] if templateNotes
Reading it takes the read scope of the kind of the item:
templates:read,forms:readorautomations:read. A key with none of the three is refused with 403insufficient_scopebefore the link is looked up, and a key without the one the item needs is refused once it is found.A token that no public link has is a 404
shared_item_not_found, and so is the link of an item its owner made private or deleted.Read only, so the SDK retries it after a network failure like any other read.
Also available in
- API
GET /shared/{token}- TypeScript
shared.get()- Python
shared.get()- PHP
shared->get- Go
Shared.Get- Java
shared().get- C#
Shared.GetAsync- CLI
nextmail shared get
shared.copy
Copy a shared template, form or automation into this workspace
copy(token, api_key: nil) -> HashCopies the item at a public link into this workspace as a new draft, as Copy to my workspace does on the page, and returns 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.
Parameters
tokenStringRequiredThe token at the end of the public link:
tokenon a link thatshare_links.listorshare_links.getreturns, or the last part of itsurl.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with object set to shared_copy, kind, id, name and templateIds, answered with status 201. id is the new template, form or automation, a draft here, name the name it got, and templateIds the templates copied along with an automation, empty for the rest.
Example
copy = client.shared.copy("9c4e2a7f1b6d3e8a0f5c2b7d4e1a9f36") puts copy[:kind], copy[:id], copy[:name] puts "templates copied with it: #{copy[:templateIds].join(", ")}" if copy[:templateIds].any?Notes
Copying takes the write scope of the kind of the item, and an automation that sends templates also takes
templates:write. A key without them is refused with 403insufficient_scope, and nothing is copied.An item its owner shares to look at, not to copy, is a 403
share_not_copyable. A token that no public link has, or the link of an item made private or deleted, is a 404shared_item_not_found.Workspace limits apply as they do to anything created here, so a workspace that already holds as many templates, forms or automations as it may answers 422
workspace_limit_reached. Nothing is kept then: the templates copied for an automation are removed again when the automation cannot be made.The SDK does not retry a copy, because a second call makes a second copy.
Also available in
- API
POST /shared/{token}/copy- TypeScript
shared.copy()- Python
shared.copy()- PHP
shared->copy- Go
Shared.Copy- Java
shared().copy- C#
Shared.CopyAsync- CLI
nextmail shared copy
Google Workspace