PAparagraph-xyz
content

Archive a piece of content

Changed on

Put a piece away without deleting it. Archived content drops out of the default list and out of the writer's Content surface, and POST /v1/content/{contentId}/restore brings it back.

Any suggestion still proposing the piece is dismissed along with it, so nothing is left offering to send something you've filed away. A piece with a send already queued can't be archived — cancel the schedule first.

post/v1/content/{contentId}/archive

Request

  • Base URL
    https://public.api.paragraph.com/api
  • URL
    https://public.api.paragraph.com/api/v1/content/{contentId}/archive
  • Auth
    HTTP bearer

Path parameters

contentIdstring required

Unique identifier of the content

Request body

object required

Response

Content archived successfully

idstring required

Unique identifier for this piece of content

kindstring required

What this piece is: tweet, linkedin, newsletter, or x_article

titlestring required

What this piece is called in your library

excerptstring required

First readable line of the body, for listing views

status'draft' | 'published' | 'archived' required

Whether this piece has been delivered, is still a draft, or was archived

scheduledboolean required

Whether a scheduled send is queued against this piece

lockedReasonstring nullable required

Why this piece can't be edited right now, or null when it can. A queued or in-flight send locks the words, because they go out exactly as written.

publishedAtstring nullable required

ISO 8601 timestamp of the first delivery, or null

urlstring nullable required

Where this piece went live, from the same delivery publishedAt came from. Null when it hasn't been delivered, and null by design for a channel that publishes no page: a custom email renders into the message itself, so there is no address to link to. Never guessed — a delivery whose id isn't shaped like its channel reports null rather than a link that would 404.

archivedAtstring nullable required

ISO 8601 timestamp of when this piece was archived, or null

bucketIdstring nullable required

The bucket grouping this piece with the post it was made from, or null when it stands alone. Read it back with GET /v1/buckets/{bucketId}.

createdAtstring required

ISO 8601 timestamp of creation

updatedAtstring required

ISO 8601 timestamp of the last change

bodyobject required

The artifact itself, in the shape its kind uses

Changes