Marketing
Marketing turns a release into what you tell your customers. Draft a release's customer-facing release notes from what shipped and the customer feedback behind it, edit them, then approve and publish them once the release is Released. Every publish keeps a numbered copy of exactly what customers were told. Unpublish takes the live notes down and keeps every version; Republish puts the newest version back. See Marketing.
Get readers' likes and dislikes on the release notes
Readers' likes and dislikes on the workspace's public release notes in What's new, all time: the totals, and one row per notes document anyone reacted to, newest Marketing release first. The totals are the sums of the rows. Only Productmind's own workspace has reactions, because its notes are the only ones What's new shows; anywhere else available is false and everything is empty. Blog posts and customer emails carry no reactions.
path Parameters
workspaceIdWorkspace UUID
Get readers' likes and dislikes on the release notes › Responses
The reactions
List Marketing releases
The workspace's Marketing releases, newest first, each with how many sources of each kind it has, its public release notes documents and their states, its blog posts' states and how many customers were emailed. Archived ones are left out unless status asks for them. search matches a title or a number (MKT-3). Pass materials=with for the Marketing releases that have public release notes or a blog post, materials=without for those with none yet.
path Parameters
workspaceIdWorkspace UUID
query Parameters
materialswith lists only Marketing releases that have materials (public release notes or a blog post), without only those that have none yet. Omit it for every one.
statusThe statuses to list, comma-separated. Omitted: every status but archived.
searchA title, or a number (MKT-3, 3).
pageThe page to read, counted from 1. Omitted: the first page.
limitHow many Marketing releases a page holds, at most 50. Omitted: 50.
List Marketing releases › Responses
Marketing releases
Create a Marketing release
Create a Marketing release with a title, Planned, and optionally attach its first sources: technical releases, features, feature requests or customer feedback. No source is needed to create one. A source that cannot be attached (a private feature, or one not found in the workspace) refuses the whole request and nothing is created.
path Parameters
workspaceIdWorkspace UUID
Create a Marketing release › Request Body
titleSources to attach at once; none is needed.
Create a Marketing release › Responses
The new Marketing release
Get a Marketing release
A Marketing release's overview: its title and status, its sources, what drafts will be written from (the customer-facing features they cover and the attached releases not out yet), its public release notes documents, its blog posts, its customer emails, and whether it can still be deleted.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
Get a Marketing release › Responses
The Marketing release
Delete a Marketing release
Delete a Marketing release with its drafts, comments and tags. Only while nothing of it was ever published, approved or emailed; after that, archive it instead. Its sources are not touched.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
Delete a Marketing release › Responses
Deleted
Update a Marketing release
Change a Marketing release's title, its status (Planned, In progress, Announced, Archived), or both. The status is set by hand and blocks nothing; Archived hides it from the list.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
Update a Marketing release › Request Body
titlestatusUpdate a Marketing release › Responses
The Marketing release
Get a Marketing release's brief
What a Marketing release announces, resolved for making its materials, such as a clip, a banner or a post: its public release notes documents with their text (the live version's, which is what customers read, or the working draft where none is live), its blog posts, the customer-facing features its sources cover, and the sources text its drafts are written from. The Marketing release's own title and number are the team's names for it, never customer copy: take wording from the notes. Private features and customers' names are left out. Long text is cut to fit and flagged truncated.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
Get a Marketing release's brief › Responses
The brief
List a Marketing release's sources
What the Marketing release's drafts are written from: its attached releases, features, feature requests and customer feedback, grouped by kind, newest first. A source deleted since, or a feature made private, is not listed.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
List a Marketing release's sources › Responses
The sources
Attach sources to a Marketing release
Attach one or more sources. Ones already attached are skipped. A private feature, an id not found in the workspace, or going past the limit of sources refuses the whole request. Answers the sources as they stand.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
Attach sources to a Marketing release › Request Body
Attach sources to a Marketing release › Responses
The sources
Detach a source from a Marketing release
Detach one source. The source itself is not changed, and what was already written from it stays as it is. Answers the sources left.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
sourceTypeThe source's type: release, feature, feature_request or customer_interaction (customer feedback).
sourceIdThe source's UUID
Detach a source from a Marketing release › Responses
The sources left
List a Marketing release's media
The media made for a Marketing release and ready to be used: its clips, loops, posters, banners and captions files, a campaign's together, each with its kind, its cut (format, theme, banner target), its size and, for a campaign that was published, its public address. A file still being uploaded is not listed. Use it to see what a release already has before making more, and to pick a file to attach or link.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
List a Marketing release's media › Responses
The media
Get links to a Marketing release's media files
A link to the bytes of every ready media file of a Marketing release, by the file's id, each shown in place under the file's own name and type and good for an hour. For a page that shows them all at once; for one file, ask for its own link.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
Get links to a Marketing release's media files › Responses
The links
Request upload links for a Marketing release's media
The first of two calls that put files into a Marketing release's media. Announce up to 100 files (name, media type, exact size in bytes, sha256, kind) and get one upload link each, good for an hour. Send each file to its link with an HTTP PUT of its bytes and exactly the headers given, then call confirm-marketing-media with the ids. Nothing is listed until it is confirmed. Give campaign for a rendered campaign: its files then take the place of the ones delivered before under the same names, once they have arrived. A Marketing release holds a limited number of files; past it the request is refused and nothing is made.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
Request upload links for a Marketing release's media › Request Body
The files to make a place for, at most 100 a call. Each gets its own upload link in the answer.
The campaign these files were rendered from. Give it for a rendered campaign: its files then replace the ones delivered before under the same names. Leave it out for a single file of your own.
sessionId^([0-9a-fA-F]{8}-[0-…The coding session that rendered the files, when one did: its own session id.
Request upload links for a Marketing release's media › Responses
One upload link a file
Confirm uploaded media of a Marketing release
The second of the two calls: after sending each file to its upload link, pass the ids here. Each file is looked for in storage. One that is there, at the size it was announced with, becomes ready and is listed in the Marketing release's media, taking the place of an earlier file of the same campaign and name. One that is not is answered under missing with why; upload it and confirm again. Confirming a file twice changes nothing.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
Confirm uploaded media of a Marketing release › Request Body
mediaIdsThe ids of the files that were uploaded, from request-marketing-media-uploads. Each is looked for in storage.
Confirm uploaded media of a Marketing release › Responses
The files found, and the ones missing
Delete a media file of a Marketing release
Remove one file from a Marketing release's media, with its stored copy. A copy published to a public address, or already inserted into a document or sent somewhere, is not touched.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
mediaIdMedia file UUID
Delete a media file of a Marketing release › Responses
Deleted
Rename a media file of a Marketing release
Change what a media file is called in the Marketing release's media. Null or an empty label clears it; the file itself and its name are not changed.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
mediaIdMedia file UUID
Rename a media file of a Marketing release › Request Body
What a person calls the file; null or empty clears it.
Rename a media file of a Marketing release › Responses
The media file
Get a link to a media file of a Marketing release
A link to one ready media file's bytes, served under the file's own name and type, good for a few minutes: shown in place by default, or saved as a file with disposition=attachment. Ask again for a new one; a file that is not ready answers 404.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
mediaIdMedia file UUID
query Parameters
dispositioninline (the default) for a link a player or an image shows in place; attachment for one a browser saves under the file's name.
Get a link to a media file of a Marketing release › Responses
The link
List a Marketing release's public release notes
The Marketing release's public release notes documents, newest first, each with its headline, its state, the draft being written if any, and when it was first and last published.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
List a Marketing release's public release notes › Responses
Public release notes documents
Create public release notes
Start a new public release notes document. Without generate it is empty, to write yourself (201). With generate a first draft is written from the Marketing release's sources in the background (202): that needs at least one source, and sources with no customer-facing feature need acknowledgeInternalOnly. Each document is published on its own.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
Create public release notes › Request Body
generateWrite a first draft from the sources in the background.
acknowledgeInternalOnlyWith generate: the person chose Generate anyway on sources that hold no customer-facing feature.
Create public release notes › Responses
The new document
Get public release notes
One public release notes document: its draft, its state, what it is written from, the draft being written if any, and every published version.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
notesIdPublic release notes document UUID
Get public release notes › Responses
The release notes
Save the customer-facing release notes draft
Save the draft's headline, summary and capabilities. Saving after a publish leaves the published version live until the next publish.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
notesIdPublic release notes document UUID
Save the customer-facing release notes draft › Request Body
headlinesummarybodySave the customer-facing release notes draft › Responses
The release notes
Draft customer-facing release notes
Start drafting the document in the background, from the Marketing release's sources: the attached releases' shipped work, the features, the feature requests and the anonymized customer feedback. Returns the run; the draft appears on the document when it is done. Needs at least one source. A run already in progress is returned instead of starting another. Replacing existing text needs confirmOverwrite.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
notesIdPublic release notes document UUID
Draft customer-facing release notes › Request Body
confirmOverwriteRequired when the document has text: the person confirmed replacing it.
acknowledgeInternalOnlyThe person chose Generate anyway on sources that hold no customer-facing feature.
Draft customer-facing release notes › Responses
The run
Stop drafting customer-facing release notes
Stop the draft being written. The document's text, if any, is left as it was.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
notesIdPublic release notes document UUID
Stop drafting customer-facing release notes › Responses
The stopped run
Check whether the customer-facing notes can be published
What blocks publishing the document's current draft (an attached release not out yet among them), the names on record that appear in it, whether it quotes customers, and the version a publish would create.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
notesIdPublic release notes document UUID
Check whether the customer-facing notes can be published › Responses
The publish check
Approve and publish the customer-facing release notes
Publish the document's current draft as its next numbered version, keeping an exact copy of what customers were told. Waits until every release attached as a source is Released; with none attached, nothing waits. Only for the draft the person reviewed. Needs a person's own sign-in.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
notesIdPublic release notes document UUID
Approve and publish the customer-facing release notes › Request Body
expectedUpdatedAtThe draft's updatedAt the person reviewed; a newer draft refuses the publish.
quotesReviewedThe person confirmed every customer quote is anonymized. Required when the notes quote customers.
Approve and publish the customer-facing release notes › Responses
The release notes
Unpublish the customer-facing release notes
Withdraw the document's live version. Every published version is kept, and none of this document is live until it is republished or a new version is published. Other notes documents are not affected. version must be the newest published version. Needs a person's own sign-in.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
notesIdPublic release notes document UUID
Unpublish the customer-facing release notes › Request Body
versionThe newest published version the person confirmed unpublishing.
Unpublish the customer-facing release notes › Responses
The release notes
Republish the customer-facing release notes
Make the document's newest published version live again, without creating a new version. Waits until every release attached as a source is Released. version must be the newest published version. Needs a person's own sign-in.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
notesIdPublic release notes document UUID
Republish the customer-facing release notes › Request Body
versionThe newest published version the person confirmed making live again. No new version is created.
Republish the customer-facing release notes › Responses
The release notes
Get a published version of the customer-facing notes
The exact text of one published version of the document.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
notesIdPublic release notes document UUID
publicationIdPublished version UUID
Get a published version of the customer-facing notes › Responses
The published version
Get reader feedback on public release notes
What readers of Productmind's public release notes in What's new said about this notes document: how many liked and disliked it and how many people opened it in full, each counted once, and every feedback conversation started from it, with the passage the reader highlighted and the section it sits under. Only Productmind's own workspace has reader feedback; anywhere else available is false. Needs Marketing and Customer meetings & support read access.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
notesIdPublic release notes document UUID
Get reader feedback on public release notes › Responses
The reader feedback
List who reacted to public release notes
Who liked or disliked this public release notes document in What's new, newest first: each person's name, email, the organization they were signed into, their reaction and when. reaction narrows the list to likes or dislikes. Only Productmind's own workspace has reactions; anywhere else available is false. Needs Marketing and Contacts read access.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
notesIdPublic release notes document UUID
query Parameters
reactionOnly likes or only dislikes. Left out, both.
pagelimitList who reacted to public release notes › Responses
A page of reactions
List what a blog post can be written about
What a blog post of the Marketing release can be written about: the customer-facing features its sources cover, each with whether it has a specification and how many customer requests are behind it, and each of its published release notes documents (its newest version) split into the passages a post can elaborate.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
List what a blog post can be written about › Responses
The scope options
List a Marketing release's blog posts
The Marketing release's blog posts, newest first, each with its title, its scope (features and release notes passages), its state and the draft being written if any.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
List a Marketing release's blog posts › Responses
Blog posts
Start a blog post
Create a blog post of the Marketing release about customer-facing features its sources cover and/or passages of one of its published release notes documents (named by notesId and notesVersion), and start drafting it in the background. A feature with no specification needs acknowledgeMissingSpecifications.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
Start a blog post › Request Body
acknowledgeMissingSpecificationsThe person chose Generate anyway with a feature in scope that has no specification.
Start a blog post › Responses
The post and its first run
Get a blog post
A blog post: its text, its scope, the draft being written if any, its approved versions and what stands in the way of approving it.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
postIdBlog post UUID
Get a blog post › Responses
The blog post
Delete a blog post
Delete a blog post with its drafts, comments, tags and approved versions. A post on the blog is refused: unpublish it first.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
postIdBlog post UUID
Delete a blog post › Responses
Deleted
Draft a blog post again
Start a new draft of the post in the background, with new guidance (tone, length, angle) and optionally a new scope. Replacing a post that has text needs confirmOverwrite. A draft already being written is returned instead of starting another.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
postIdBlog post UUID
Draft a blog post again › Request Body
A new scope; the post's own when omitted.
confirmOverwriteRequired when the post has text: the person confirmed replacing it.
acknowledgeMissingSpecificationsThe person chose Generate anyway with a feature in scope that has no specification.
Draft a blog post again › Responses
The run
Change what a blog post is about
Save the features and release notes passages the post's next draft is written from, without writing a draft. The post's text is left as it is. Refused while a draft is being written.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
postIdBlog post UUID
Change what a blog post is about › Request Body
Change what a blog post is about › Responses
The blog post
Stop drafting a blog post
Stop the draft being written. The post's text, if any, is left as it was.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
postIdBlog post UUID
Stop drafting a blog post › Responses
The stopped run
Check whether a blog post can be approved
What blocks approving the post, the names on record that appear in it, whether it quotes customers, and the version an approval would create.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
postIdBlog post UUID
Check whether a blog post can be approved › Responses
The approval check
Approve a blog post
Save the post as the next numbered approved version, ready for the blog page. Waits until every release attached as a source is Released, and only for the text the person reviewed. Nothing is published: the blog keeps the version it serves until the post is published again. Needs a person's own sign-in.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
postIdBlog post UUID
Approve a blog post › Request Body
expectedUpdatedAtThe post's updatedAt the person reviewed; a newer post refuses the approval.
quotesReviewedThe person confirmed every customer quote is anonymized. Required when the post quotes customers.
Approve a blog post › Responses
The blog post
Publish a blog post to the blog
Put the post's newest approved version on Productmind's blog, or move the blog to it when the post is already there (Update published), with the summary, the picture at the top and the byline given. A newer approval changes nothing on the blog until the post is published again. The slug is chosen at the first publish and kept from then on. Asks for a deploy of the blog afterwards; the post is published whatever the deploy does, and the answer says how the deploy went. Productmind's own workspace only. Needs a person's own sign-in.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
postIdBlog post UUID
Publish a blog post to the blog › Request Body
summaryWhat the blog's index and link previews say of the post.
expectedUpdatedAtThe post's updatedAt the person reviewed; a newer post refuses the publish.
slugThe post's address on the blog. Required on its first publish, then fixed: a later publish may leave it out or send the same one.
A ready image, loop or clip of the post's Marketing release's media shown at the top of the post; none when left out.
Who the post is by, as the blog shows it; none when left out or empty.
Publish a blog post to the blog › Responses
The blog post and the deploy
Take a blog post off the blog
Take the post off Productmind's blog. Its approved versions, the version the blog served and its slug are kept, so publishing it again puts it back at the same address. Asks for a deploy of the blog afterwards. Productmind's own workspace only. Needs a person's own sign-in.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
postIdBlog post UUID
Take a blog post off the blog › Responses
The blog post and the deploy
Deploy the blog again
Ask for a deploy of Productmind's blog with the posts on it now, after one failed or its answer was lost. A second press within half a minute, when nothing on the blog changed since the latest deploy, answers that deploy instead of starting another. The answer is the deploy as recorded: dispatched, failed (nothing started) or unknown (the answer was lost: a deploy may have started). Productmind's own workspace only. Needs a person's own sign-in.
path Parameters
workspaceIdWorkspace UUID
Deploy the blog again › Responses
The deploy
Get the blog's status
Whether Productmind's blog serves the posts on it now: the revision of the posts as published here, beside the revision the blog itself says it was built from, read from the blog when asked, and the newest deploy. Where the blog cannot be read, or this environment has no blog, it says so. Productmind's own workspace only.
path Parameters
workspaceIdWorkspace UUID
Get the blog's status › Responses
The blog's status
Get an approved version of a blog post
The exact text of one approved version.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
postIdBlog post UUID
publicationIdApproved version UUID
Get an approved version of a blog post › Responses
The approved version
Get a Marketing release's customer emails
Every customer behind a request or a reported bug that the Marketing release's sources cover, each with their items, their personalized email (the written draft or a person's edit), whether they can be emailed, and what was sent to them. Also the live release notes documents the emails can summarize, what stands in the way of sending, the drafts being written, and the customers that could not be reached. Needs Marketing and Contacts read access.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
Get a Marketing release's customer emails › Responses
The customer emails
Write the customer email drafts
Write a short highlight for each request and bug the sources cover in the background; each customer's email is put together from their own items, with a summary of the rest from one live release notes document (notesId, else the most recently published). A person's edits are never replaced. Drafts already being written are returned instead of starting again.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
Write the customer email drafts › Request Body
notesId^([0-9a-fA-F]{8}-[0-…A live notes document of the Marketing release; the most recently published one when omitted.
Write the customer email drafts › Responses
The run
Stop writing the customer email drafts
Stop the drafts being written. The drafts written before, and every edit, stay as they were.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
Stop writing the customer email drafts › Responses
The stopped run
Edit a customer's email subject
Save a person's edit of one customer's email subject. The text is edited in the email's collaborative document. Saved whatever its length; the limits refuse the send.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
contactIdThe recipient's contact UUID
Edit a customer's email subject › Request Body
subjectEdit a customer's email subject › Responses
The customer emails
Reset a customer's email to the written draft
Discard a person's edit of one customer's email, so it reads as the written draft again. Its comments are kept.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
contactIdThe recipient's contact UUID
Reset a customer's email to the written draft › Responses
The customer emails
Open a customer's email as a document
The collaborative document of one customer's email, made on first open from the written draft. An email nobody edited is written again for the person opening it.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
contactIdThe recipient's contact UUID
Open a customer's email as a document › Responses
The email's document
Send customer emails
Send the reviewed email to each named customer, at most 50 at a time, from the organization via Productmind with replies to the sender. Needs live release notes, no drafts being written, and every release attached as a source Released. Each customer is judged on its own: one already emailed needs sendAgain, a changed draft or a send by someone else meanwhile is refused, and a refusal never stops the others. Needs a person's own sign-in.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
Send customer emails › Request Body
namesReviewedThe person confirmed no draft identifies another customer. Required when a draft may name one.
Send customer emails › Responses
What happened to each customer
List a Marketing release's customer email sends
Every attempt to email a customer about the Marketing release, newest first: who, what it covered, which release notes it summarized, its status, who sent it and when.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
query Parameters
pageList a Marketing release's customer email sends › Responses
The send log
Get a customer email send
One attempt from the send log, with the exact text that was sent.
path Parameters
workspaceIdWorkspace UUID
releaseIdMarketing release UUID or MKT-n
sendIdSend UUID
Get a customer email send › Responses
The send
Get a Marketing document
Read one Marketing document whole: one of a Marketing release's public release notes documents, one of its blog posts, or one customer's email about it. Returns its current text exactly as it stands (copy suggestion passages from it), whether a new draft is being written, and any suggestion already waiting for review.
path Parameters
workspaceIdWorkspace UUID
kindWhich Marketing document: release-notes (one of a Marketing release's public release notes), blog-post (one of its blog posts) or customer-email (one customer's email about it).
documentIdThe document's id, as your turn input or the document read names it.
Get a Marketing document › Responses
The document
Suggest a change to a Marketing document
Suggest a change to a Marketing document while answering a comment thread on it: edits (exact find-and-replace passages of its current text) or, to rewrite all of it, content. Nothing changes until a person reviews the suggestion block by block and applies it, which also resolves the thread. Taken only from the thread you were asked to answer (commentId); refused while a suggestion is already waiting or a new draft is being written.
path Parameters
workspaceIdWorkspace UUID
kindWhich Marketing document: release-notes (one of a Marketing release's public release notes), blog-post (one of its blog posts) or customer-email (one customer's email about it).
documentIdThe document's id, as your turn input or the document read names it.
Suggest a change to a Marketing document › Request Body
summaryOne line on what the suggestion changes, shown above the review.
commentIdThe id of the comment thread you are answering, exactly as your turn input names it. Required: a suggestion is only taken from the thread you were asked to answer, while you answer it. Applying it resolves the thread.
The change, as exact find-and-replace edits on the document's current text, applied in order, all or none. Each find is copied exactly (same characters, spacing and line breaks) from the text get-marketing-document returns, and occurs exactly once there: include enough surrounding text to make it unique. replace is the new text. Change only the passage the thread is about; every other passage stays as it is. Prefer this over content.
contentThe WHOLE new document, only when the thread asks to rewrite all of it. Never send it with edits.
Suggest a change to a Marketing document › Responses
The suggestion, waiting for review
Put a media file into a Marketing document
Copy one ready loop, poster or banner of the Marketing release's media into one of its public release notes documents or blog posts, as an image of that document. The copy is the document's own: it follows the document's image rules, starts private, and stays when the media file is deleted later. A clip or a captions file is refused, and so is a media file of another Marketing release (404).
path Parameters
workspaceIdWorkspace UUID
kindWhich Marketing document: release-notes (one of a Marketing release's public release notes), blog-post (one of its blog posts) or customer-email (one customer's email about it).
documentIdThe document's id, as your turn input or the document read names it.
Put a media file into a Marketing document › Request Body
mediaId^([0-9a-fA-F]{8}-[0-… · requiredThe media file to put into the document: a ready loop, poster or banner of the same Marketing release.
Put a media file into a Marketing document › Responses
The document's new image
Get the suggestion waiting on a Marketing document
The suggestion waiting for review on a Marketing document, with the text it was made against and the whole text it proposes, or null.
path Parameters
workspaceIdWorkspace UUID
kindWhich Marketing document: release-notes (one of a Marketing release's public release notes), blog-post (one of its blog posts) or customer-email (one customer's email about it).
documentIdThe document's id, as your turn input or the document read names it.
Get the suggestion waiting on a Marketing document › Responses
The waiting suggestion
Apply a suggestion to a Marketing document
Write the text composed in the review (the accepted parts of the suggestion on the document's current text) as the document, and resolve the comment thread it answered. Refused while a new draft is being written. Needs a person's own sign-in.
path Parameters
workspaceIdWorkspace UUID
kindWhich Marketing document: release-notes (one of a Marketing release's public release notes), blog-post (one of its blog posts) or customer-email (one customer's email about it).
documentIdThe document's id, as your turn input or the document read names it.
proposalIdSuggestion UUID
Apply a suggestion to a Marketing document › Request Body
contentThe document's new text, as composed in the review.
Apply a suggestion to a Marketing document › Responses
The applied suggestion
Dismiss a suggestion on a Marketing document
Dismiss the suggestion waiting on a Marketing document. Nothing is written and the comment thread stays open. Needs a person's own sign-in.
path Parameters
workspaceIdWorkspace UUID
kindWhich Marketing document: release-notes (one of a Marketing release's public release notes), blog-post (one of its blog posts) or customer-email (one customer's email about it).
documentIdThe document's id, as your turn input or the document read names it.
proposalIdSuggestion UUID
Dismiss a suggestion on a Marketing document › Responses
The dismissed suggestion
Make a Marketing image public
Give an image in public release notes, a blog post or a customer email a stable link that loads without signing in, so What's new and sent customer emails can show it. Only a PNG, JPG, GIF or WebP image of a Marketing document, checked byte for byte first; anything else answers 404. Needs the right to publish Marketing content and a person's own sign-in.
path Parameters
workspaceIdWorkspace UUID
attachmentIdThe image's attachment UUID
Make a Marketing image public › Responses
The image, with its public link
Make a Marketing image private
Take a Marketing image's public link away: it stops loading at once, and the image is left out of What's new and customer emails from then on. A copy a mail client already fetched is out of reach.
path Parameters
workspaceIdWorkspace UUID
attachmentIdThe image's attachment UUID
Make a Marketing image private › Responses
The image, private again