RebelMouse Private API Drafts API

Drafts API

The drafts API supports creating drafts, updating already saved drafts, and publishing drafts on site.

Creating drafts

Creates a draft and sets current user as an author by default.

POST /api/1.3/drafts

Important

We provide another endpoint for backward compatibility with 1.1 API version:

POST /api/1.1/posts

Parameters

Name	Type	Description
headline	String	Headline - Required
body	String	Body - Optional
basename	String	Slug - Optional - It's automatically generated based on headline, by default
subheadline	String	Subheadline - Optional
tags	Array of strings	Tags - Optional
primary_tag	String	Primary tag - Optional
sections	Array of strings	Sections - Optional
primary_section	String	Primary section - Optional
og_title	String	Social headline - Optional
og_description	String	Social description - Optional
image_id	Integer	ID of the uploaded image - Optional
photo_credit	String	Photo credit - Optional
manual_image_crops	Object	Crops calculated when uploading image - Optional
listicle	Array of objects	Listicles, refer to listicles document for more information - Optional
roar_author_ids	Array of integers	Author IDs - Optional
roar_specific_data	Object	Custom fields - Optional
created_ts	Integer	Publishing date - Optional - Defaults to current timestamp

Note

• primary_section and sections fields are eligible by title using insensitive case mode. "Home" can be passed if you want to set draft in homepage.
• image_id can be found as id in Image API response when uploading or editing images.
• manual_image_crops can be also found as manual_image_crops in Image API response when editing images.
• In order to control the place where the listicles are going to be rendered inside the body, it's required to introduce a listicle HTML tag.
• By default, roar_author_ids is automatically populated with the ID of the user identified with the API Key sent in request.

Roar Specific Data

Name	Type	Description
keep_reading_button_text	String	Text to be displayed on Keep Reading Button - Optional
keep_reading_hide_word_count	Boolean	Controls whether words count is going to be displayed - Optional - Defaults to false

Response

The response can contain several fields, but would like to highlight some of them that were specially requested:

Name	Type	Description
post_url	String	URL for the draft when is published.
draft_url	String	Composited by post_url + "?draft=1", which enables users to see draft page.
slug	String	URL path from post_url.

Editing drafts

Edits a draft.

PUT /api/1.3/drafts/<id>

Parameters and Response

The same specification from creating drafts applies here.

Publishing drafts

Publishes a draft.

PUT /api/1.3/drafts/<id>

Parameters and Response

In addition to the specification from updating drafts, an "action" parameter with value "publish" can be sent to API in order to publish a draft.

Name	Type	Description
action	String	Action to be performed. Optional. Choices: "publish"

Note

• draft_url is not returned in response payload when publishing a draft.
• Stored data from the draft will be published if not received updated data is coming within request payload.