Style Guides API

GET/styleguides

Retrieve all your saved Style Guides.

Request

Request Headers

Header Value
Content-Type application/json
Accept application/json
Authorization Bearer (using bearer token from /oauth/token)

Response

Response Status Codes

Code Description
200 OK
400/401 Unauthorized
403 Forbidden
500 Internal Server Error

Example Successful Response

{
    "current_page": 1,
    "last_page": 1,
    "result_count": 4,
    "total_count": 4,
    "result": [
        {
            "id": 3,
            "name": "Inbound Marketing (e.g. onsite blog posts)",
            "guide": "<p>This article will be published on our company's blog using a pseudonym. Generally, we are attempting to promote our products or services in a way that address a hypothetical customer's need. Please keep this goal and our audience in mind (what does the customer need; how does the product/service address the need). <strong>Be sure to read the assignment instructions carefully.</strong> Unless otherwise instructed by the assignment, please keep the language and tone of your article as professional as possible.</p>\r\n<p>If you have questions or suggestions on how to improve the article, please contact us.>br />Requirements:</p>\r\n<ul>\r\n<li><strong>Focus on solving the customer need.</strong></li>\r\n<li><strong>Do not disparage the client, industry or products.</strong></li>\r\n<li><strong>Please use and cite official sources</strong> to support your information (official source = .gov, .edu, or any media outlet. Any article referencing Wikipedia, about.com, ehow, or commercial sites will be sent back for revision).</li>\r\n<li><strong>Please do not cite competitors or mention competing products/services as alternatives.</strong></li>\r\n<li><strong>Please use section headers.</strong></li>\r\n</ul>"
        },
        {
            "id": 4,
            "name": "Promotional Blog Post (e.g. product reviews)",
            "guide": "<p>This article will be published on our company's blog using a pseudonym. The goal of the post is to promote the product/service/topic referenced. Please highlight the features of the topic, tailored to resonate with a potential client. <strong>Be sure to read the assignment instructions carefully.</strong> Unless otherwise instructed by the assignment, please keep the language and tone of your article as professional as possible.</p><ul><li><strong>Do not disparage the client, industry or products.</strong></li><li><strong>Please do not cite competitors or mention competing products/services as alternatives.</strong></li><li><strong>Please use and cite official sources</strong> to support your information (official source = .gov, .edu, or any media outlet. Any article referencing Wikipedia, about.com, ehow, or commercial sites will be sent back for revision).</li><li><strong>Please use section headers.</strong></li></ul>"
        },
        {
            "id": 5,
            "name": "Thought Leader (e.g. white papers)",
            "guide": "<p>This article will be published on a blog using a pseudonym. The post is intended to communicate a unique perspective and new insight to the topic at hand. Keep in mind that the audience will likely be individuals with a wealth of knowledge in the subject matter area, therefore, avoid descriptions of basic concepts, terms, etc. Additional research may be necessary in order to speak with an authoritative tone. This should not be an \"introduction to\" article. <strong>Be sure to read the assignment instructions carefully.</strong> Unless otherwise instructed by the assignment, please keep the language and tone of your article as professional as possible.</p><ul><li><strong>Please use and cite official sources</strong> to support your information (official source = .gov, .edu, or any media outlet. Any article referencing Wikipedia, about.com, ehow, or commercial sites will be sent back for revision).</li><li><strong>Please refrain from \"parroting\" other thought leaders in the area.</strong></li><li><strong>Please use section headers.</strong></li><li><strong>Quotes from famous individuals (though not competitors) may be worked in to lend credibility and draw parallels.</strong></li></ul>"
        },
        {
            "id": 6,
            "name": "Press Releases",
            "guide": "<p>A press release should present newsworthy information without sounding commercial. Avoid using language that sounds more like an advertisement than an announcement of some newsworthy change. Please make the subject of the press release seem as new and newsworthy as possible.</p>\r\n<p>Please do not use first or second person—do not use \"you/yours\" or \"us/we/ours\".</p>\r\n<p>Do not include quotes.</p>\r\n<p>Please include an italicized subheading elaborating on the title. (For example, if the title is \"[Company] Announces New Products for Preparing Roofs for Winter\", a good subheading might read \"Homeowners Encouraged to Prepare Homes for Harsher Weather\" or something to that effect.)</p>\r\n<p>At the end of the press release, include an \"about\" section with general information about the company, including contact by phone, email, and website URL.</p>"
        }
    ]
}

Example Error Response

{
    "error": "forbidden",
    "error_description": "You are not authorized to access this resource"
}

POST/styleguides

Create a new Style Guide.

Request

Request Headers

Header Value
Content-Type application/json
Accept application/json
Authorization Bearer (using bearer token from /oauth/token)

Request Parameters

Field Description Required
name Name for the new Style Guide Yes
guide Style Guide in HTML format (basic tags only, all classes, inline styles, and other attributes will be removed).
Permitted tags: h1, h2, h3, h4, h5, h6, p, a, strong, em, br, ul, ol, li
Yes

Example Request Body

{
    "name": "Inbound Marketing (e.g. onsite blog posts)",
    "guide": "<p>This article will be published on our company's blog using a pseudonym. Generally, we are attempting to promote our products or services in a way that address a hypothetical customer's need. Please keep this goal and our audience in mind (what does the customer need; how does the product/service address the need). <strong>Be sure to read the assignment instructions carefully.</strong> Unless otherwise instructed by the assignment, please keep the language and tone of your article as professional as possible.</p>\r\n<p>If you have questions or suggestions on how to improve the article, please contact us.>br />Requirements:</p>\r\n<ul>\r\n<li><strong>Focus on solving the customer need.</strong></li>\r\n<li><strong>Do not disparage the client, industry or products.</strong></li>\r\n<li><strong>Please use and cite official sources</strong> to support your information (official source = .gov, .edu, or any media outlet. Any article referencing Wikipedia, about.com, ehow, or commercial sites will be sent back for revision).</li>\r\n<li><strong>Please do not cite competitors or mention competing products/services as alternatives.</strong></li>\r\n<li><strong>Please use section headers.</strong></li>\r\n</ul>"
}

Response

Response Status Codes

Code Description
200 OK
400 Malformed Request Body (not valid JSON)
401 Unauthorized
403 Forbidden
422 Failed Validation
500 Internal Server Error

Example Response

{
    "id": 3,
    "name": "Inbound Marketing (e.g. onsite blog posts)",
    "guide": "<p>This article will be published on our company's blog using a pseudonym. Generally, we are attempting to promote our products or services in a way that address a hypothetical customer's need. Please keep this goal and our audience in mind (what does the customer need; how does the product/service address the need). <strong>Be sure to read the assignment instructions carefully.</strong> Unless otherwise instructed by the assignment, please keep the language and tone of your article as professional as possible.</p>\r\n<p>If you have questions or suggestions on how to improve the article, please contact us.>br />Requirements:</p>\r\n<ul>\r\n<li><strong>Focus on solving the customer need.</strong></li>\r\n<li><strong>Do not disparage the client, industry or products.</strong></li>\r\n<li><strong>Please use and cite official sources</strong> to support your information (official source = .gov, .edu, or any media outlet. Any article referencing Wikipedia, about.com, ehow, or commercial sites will be sent back for revision).</li>\r\n<li><strong>Please do not cite competitors or mention competing products/services as alternatives.</strong></li>\r\n<li><strong>Please use section headers.</strong></li>\r\n</ul>"
}

Example Error Response

{
    "error": "failed_validation",
    "error_description": "Some fields contained invalid values",
    "validation_errors": [
        "name": "Required"
    ]
}

GET/styleguides/{style_guide_id}

Retrieve a specific Style Guide by ID.

Request

Request Headers

Header Value
Content-Type application/json
Accept application/json
Authorization Bearer (using bearer token from /oauth/token)

Response

Response Status Codes

Code Description
200 OK
400/401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Example Successful Response

{
    "id": 3,
    "name": "Inbound Marketing (e.g. onsite blog posts)",
    "guide": "<p>This article will be published on our company's blog using a pseudonym. Generally, we are attempting to promote our products or services in a way that address a hypothetical customer's need. Please keep this goal and our audience in mind (what does the customer need; how does the product/service address the need). <strong>Be sure to read the assignment instructions carefully.</strong> Unless otherwise instructed by the assignment, please keep the language and tone of your article as professional as possible.</p>\r\n<p>If you have questions or suggestions on how to improve the article, please contact us.>br />Requirements:</p>\r\n<ul>\r\n<li><strong>Focus on solving the customer need.</strong></li>\r\n<li><strong>Do not disparage the client, industry or products.</strong></li>\r\n<li><strong>Please use and cite official sources</strong> to support your information (official source = .gov, .edu, or any media outlet. Any article referencing Wikipedia, about.com, ehow, or commercial sites will be sent back for revision).</li>\r\n<li><strong>Please do not cite competitors or mention competing products/services as alternatives.</strong></li>\r\n<li><strong>Please use section headers.</strong></li>\r\n</ul>"
}

Example Error Response

{
    "error": "not_found",
    "error_description": "Not a valid resource"
}

PATCH/styleguides/{style_guide_id}

Update an existing Style Guide. All fields are not required for this request, you need only include the ones you want to update.

Request

Request Headers

Header Value
Content-Type application/json
Accept application/json
Authorization Bearer (using bearer token from /oauth/token)

Request Parameters

Field Description Required
name New name for the Style Guide No
guide Updated Style Guide in HTML format (basic tags only, all classes, inline styles, and other attributes will be removed).
Permitted tags: h1, h2, h3, h4, h5, h6, p, a, strong, em, br, ul, ol, li
No

Example Request Body

{
    "name": "Blog Posts"
}

Response

Response Status Codes

Code Description
200 OK
400 Malformed Request Body (not valid JSON)
401 Unauthorized
403 Forbidden
404 Not Found
422 Failed Validation
500 Internal Server Error

Example Response

{
    "id": 3,
    "name": "Inbound Marketing (e.g. onsite blog posts)",
    "guide": "<p>This article will be published on our company's blog using a pseudonym. Generally, we are attempting to promote our products or services in a way that address a hypothetical customer's need. Please keep this goal and our audience in mind (what does the customer need; how does the product/service address the need). <strong>Be sure to read the assignment instructions carefully.</strong> Unless otherwise instructed by the assignment, please keep the language and tone of your article as professional as possible.</p>\r\n<p>If you have questions or suggestions on how to improve the article, please contact us.>br />Requirements:</p>\r\n<ul>\r\n<li><strong>Focus on solving the customer need.</strong></li>\r\n<li><strong>Do not disparage the client, industry or products.</strong></li>\r\n<li><strong>Please use and cite official sources</strong> to support your information (official source = .gov, .edu, or any media outlet. Any article referencing Wikipedia, about.com, ehow, or commercial sites will be sent back for revision).</li>\r\n<li><strong>Please do not cite competitors or mention competing products/services as alternatives.</strong></li>\r\n<li><strong>Please use section headers.</strong></li>\r\n</ul>"
}

Example Error Response

{
    "error": "failed_validation",
    "error_description": "Some fields contained invalid values",
    "validation_errors": [
        "name": "Cannot be empty"
    ]
}