Samva
DashboardAPI
Api referenceNewsletterIssues

Remove a newsletter issue (Preview)

Preview · Available to selected organizations. Removes one Markdown file from the draft under a revision fence.

POST
/v1/newsletters/{id}/issues/remove

Removes one Markdown file from the draft under a revision fence. The project default issue must remain. Saved commits remain readable. Requires newsletters and email.

Authorization

apiKey
headerx-api-key<token>

Path Parameters

id*string
Match^nl_[0-9a-hjkmnp-tv-z]{16,24}$

Header Parameters

idempotency-key?|null

Request Body

application/json
  1. body
path*string
Match^(?!.*\\)(?!.*(?:^|\/)\.{1,2}(?:\/|$))(?!.*(?:^|\/)\.git(?:\/|$))(?!.*\p{Cc})issues\/(?:[^/]+\/)*[^/]+\.md$
Lengthlength <= 1024
expectedRevision*string
Length1 <= length <= 1024

Response Body

Success

application/json
  1. response
workspace*
files*
Example Request
import { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.newsletters.issues.remove({  "id": "example",  "path": "example",  "expectedRevision": "example"});
Example Response
{  "workspace": {    "projectId": "string",    "organizationId": "string",    "ownerEpoch": 0,    "repositoryName": "string",    "defaultBranch": "string",    "baseCommit": "string",    "remoteHead": "string",    "pendingRemoteHead": "string",    "revision": "string",    "overlay": {      "property1": "string",      "property2": "string"    },    "assetChanges": [      {        "path": "string",        "status": "added"      }    ],    "conflicts": [      {        "path": "string",        "base": "string",        "draft": "string",        "main": "string"      }    ],    "provenance": {      "references": [        {          "kind": "string",          "digest": "string",          "locator": "string"        }      ]    },    "mounts": [      {        "kind": "project",        "root": "/project",        "access": "read-write"      }    ],    "libraryManifestDigest": "string",    "createdAt": "string",    "updatedAt": "string",    "createdBy": {      "userId": "string",      "via": "api"    },    "updatedBy": {      "userId": "string",      "via": "api"    }  },  "files": {    "property1": "string",    "property2": "string"  }}