API Endpoints

Learn how to use the API to manage your subscribers.

List posts

POST https://api.letterdrop.com/api/v1/posts

Get a summary of all your posts to be displayed on your home page. The API is paginated. Start with offset: 0 and a fixed small value for limit. We recommend 5. Then you can query again, but this time, increment the offset to 5 to get the next 5 posts. You can check if there are most posts to query by checking if hasNextPage in the response is true.

Headers

Name	Type	Description
api-key	string	API key that is unique to your workspace

Request Body

Name	Type	Description
query	string	Search for posts containing these words
offset	number	Index of first post to return
limit	number	Number of posts to return

200 The response tells you the current page, whether there is more data, the total number of posts and an array of posts you queried.

{
    success: true,
    meta: {
      page: 0,
      hasNextPage: true,
      totalPosts: 20
    },
    posts: [
      {
          "id": "6030dc61a21da91db1d593c0",
          "title": "Title",
          "subtitle": "Subtitle",
          "text": "Lorem ipsum dolor sit amet...",
          "textPreview": "Lorem ipsum dolor sit amet"
          "body": "<p>Lorem ipsum dolor sit amet,</p>",
          "slug": "my-new-post",
          "url": "https://letterdop.com/blog/my-new-post",
          "publishedOn": "2020-10-20T12:18:13.095Z",
          "coverImage": "https://cdn.letterdrop.co/images/2022/11/24/hir0hq8n.jpeg",
          "thumbnail": "https://cdn.letterdrop.co/images/2022/11/24/hir0hq8n.jpeg",
          "metaTitle": "Meta Title",
          "metaDescription": "This is a post via Letterdrop",
          "status": "published",
          "tags": ["chocolate", "food", "restaurant"],
          "updated": "2020-10-20T12:18:13.095Z",
          "publication": "piedpiper",
          "readTime": 3,
          "wordCount": 1565,
          "featured": false,
          "markdown": "Lorem ipsum dolor sit amet"
          "customFields": [
            {
              "name": "Related Posts",
              "type": "Multi-Select List",
              "value": "",
              "allowedValues": [
                "Post 1", "Post 2", ...
              ]
            },
            ...
          ]
        },
        ...
    ]
}

400

{
  success: false,
  message: "Invalid params"
}

Get post

POST https://api.letterdrop.com/api/v1/post/get/:{id}

Get a single post.

Path Parameters

Name	Type	Description
id	string	The ID of the post

Headers

Name	Type	Description
api-key	string	API key that is unique to your workspace

200 Full details on a post.

{
  "id": "6030dc61a21da91db1d593c0",
  "title": "Title",
  "subtitle": "Subtitle",
  "text": "Lorem ipsum dolor sit amet...",
  "textPreview": "Lorem ipsum dolor sit amet"
  "body": "<p>Lorem ipsum dolor sit amet,</p>",
  "slug": "my-new-post",
  "url": "https://letterdop.com/blog/my-new-post",
  "publishedOn": "2020-10-20T12:18:13.095Z",
  "coverImage": "https://cdn.letterdrop.co/images/2022/11/24/hir0hq8n.jpeg",
  "thumbnail": "https://cdn.letterdrop.co/images/2022/11/24/hir0hq8n.jpeg",
  "metaTitle": "Meta Title",
  "metaDescription": "This is a post via Letterdrop",
  "status": "published",
  "tags": ["chocolate", "food", "restaurant"],
  "updated": "2020-10-20T12:18:13.095Z",
  "publication": "piedpiper",
  "readTime": 3,
  "wordCount": 1565,
  "featured": false,
  "markdown": "Lorem ipsum dolor sit amet"
  "customFields": [
    {
      "name": "Related Posts",
      "type": "Multi-Select List",
      "value": "",
      "allowedValues": [
        "Post 1", "Post 2", ...
      ]
    },
    ...
  ]
}

400

{
  success: false,
  message: "Couldn't find post"
}

Draft post

POST https://api.letterdrop.com/api/v1/post/draft

Draft a post.

Headers

Name	Type	Description
api-key	string	API key that is unique to your workspace

Request Body

Name	Type	Description
html	string	Body of your post in HTML format
subtitle	string	Subtitle of your post
title	string	Title of your post

200 Link to post draft

{
  success: true,
  draftLink: "https://app.letterdrop.com/post/6049755c5392b01d67ffd8cf"
}

400

{
  success: false,
  message: "title can't be empty"
}

Get project

POST https://api.letterdrop.com/api/v1/project/get/:{id}

Get project details.

Headers

Name	Type	Description
api-key*	string	API key that is unique to your workspace

Request Body

Name	Type	Description
id	string	Project ID

200: OK Full project details

{
  title: "Project title",
  description: "Project description",
  labels: ["label1", "label2", "label3"],
  keyword: "keyword",
  status: "content_map_draft",
  suggestedBy: "[e-mail]",
  suggestedOn: "2022-07-19T16:43:35.033Z",
  assignedBy: "[e-mail]",
  assignedTo: "[e-mail]",
  contributors: ["[e-mail]"],
  contentMapDeadline: "2022-07-27T03:30:00.000Z",
  approvers: ["[e-mail]"],
  reviewDeadline: "2022-08-04T03:30:00.000Z",
  approvedBy: "[e-mail]",
  publishDate: "2022-08-05T03:30:00.000Z"
}
          

400: Bad Request

{
    "success": false,
    "message": "Couldn't find project"
}

Create idea

POST https://api.letterdrop.com/api/v1/idea/new

Create a new idea.

Headers

Name	Type	Description
api-key*	string	API key that is unique to your workspace

Request Body

Name	Type	Description
title*	string	Idea title
suggestedBy*	string	Email address of the person who suggested the idea
description	string	Description of the idea. This is where your content brief goes.
keyword	string	Keyword associated with the idea
labels	list	List of labels

200: OK

{
  success: true,
  title: "A Guide To B2B Marketing",
  description: "B2B marketing spans content, paid acquisition, events, and PR...",
  labels: ["b2b", "marketing", "guide"],
  keyword: "b2b marketing",
  suggestedBy: "[e-mail]",
  message: "New idea created"
}

400: Bad Request

{
  success: false,
  message: "Invalid title"
}

Assign idea

POST https://api.letterdrop.com/api/v1/idea/assign

Create a project from an idea.

Headers

Name	Type	Description
api-key*	string	API key that is unique to your workspace

Request Body

Name	Type	Description
id*	string	Idea ID
publishOn*	date	Date you want to target publishing your content.
assignedTo	string	Email address of the user writing the content.
approvers	List	List of emails of approvers

200: OK

{
    "success": true,
    "message": "Project created."
}

400: Bad Request

{
    "success": false,
    "message": "Project already created."
}