docs.storydoc.com Open in urlscan Pro
63.32.161.232  Public Scan

Form analysis
1 forms found in the DOM

POST https://docs.storydoc.com/search.json

<form class="simple_form doc-search__form" data-action="ajax:success->doc-search#onPostSuccess ajax:error->doc-search#onPostError ajax:beforeSend->doc-search#onBeforeSend" data-doc-search-target="form" action="https://docs.storydoc.com/search.json"
  accept-charset="UTF-8" data-remote="true" method="post">
  <svg width="14" height="14" viewBox="0 0 14 14" fill="none" xmlns="http://www.w3.org/2000/svg" data-doc-search-target="searchIcon">
    <path d="M13 13L10 10" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path>
    <path d="M6.14286 11.2857C8.98318 11.2857 11.2857 8.98318 11.2857 6.14286C11.2857 3.30254 8.98318 1 6.14286 1C3.30254 1 1 3.30254 1 6.14286C1 8.98318 3.30254 11.2857 6.14286 11.2857Z" stroke="currentColor" stroke-width="1.5"
      stroke-linecap="round" stroke-linejoin="round"></path>
  </svg>
  <div class="loader doc-search__loader" aria-label="Loading" aria-live="assertive" aria-hidden="true" data-loader-type="bars" data-doc-search-target="loader"></div>
  <input label="false" autocomplete="off" type="hidden" name="uid" id="uid" value="0.90dfaaf215771">
  <input label="false" autocomplete="off" autofocus="autofocus" data-doc-search-target="input" data-action="input->doc-search#submitOnType" class="string required" required="required" aria-required="true" placeholder="Search" type="text" name="query"
    id="query">
  <button type="button" class="esc-button" data-action="click->dialog#close">ESC</button>
</form>

Text Content

Show Menu
Search… Ctrl+K

ESC





Example searches: “200”, “link2”, “date”, “https://api.storydoc.com/v2”, “url”


Toggle dark mode

--------------------------------------------------------------------------------

 * API Changelog

--------------------------------------------------------------------------------

Download source
 * JSON OpenAPI specification
 * YAML OpenAPI specification


TOPICS

 * Introduction
 * Authentication


ENDPOINTS

 * versions
   * Creates a new version for a story
     POST

Powered by Bump.sh
Dismiss highlight Show more

--------------------------------------------------------------------------------

--------------------------------------------------------------------------------

--------------------------------------------------------------------------------



--------------------------------------------------------------------------------




--------------------------------------------------------------------------------


STORYDOC API
1.0.0


OVERVIEW

The Storydoc Bulk API lets you automate the creation of Storydoc versions from
your live Storydoc story templates.

Every API call will generate a unique Storydoc version link, that can later be
used just like any other version link created in the Storydoc platform.

You can use the Bulk API to create dedicated links that are identical to the
master story template. Plus, use the API can also send values fitting any
dynamic variable set up on your template. To learn more about using dynamic
variables for automated deck personalization, see our business solutions page.

Need a no-code way to automate your decks? Use our Zapier app, contact us for
more details.

This is the documentation for version 1.0.0 of the API. Last update on Apr 21,
2024.

Base URL

https://api.storydoc.com/v2


AUTHENTICATION


BEARER AUTH (HTTP)



Send a bearer token (“JWT” Formatted) in the Authorization http header to
authenticate with the API.

You can ask the Storydoc team for your API token.


VERSIONS

a story version


CREATES A NEW VERSION FOR A STORY

POST /versions

a new version will be created for the given story

application/json

BODY

Story data to add

 * daysToExpire number(integer)
 * senderEmail string(email) Required
 * data object Required
   Hide data attributes Show data attributes
    * title string Required
    * first_name string
    * last_name string
    * company string
    * date string
    * link1 string
    * link2 string
    * free_text1 string
    * free_text2 string
    * title1 string
    * title2 string
    * phone string
    * email string(email)
    * number1 number
    * number2 number
    * number3 number
    * number4 number
    * number5 number
    * number6 number

RESPONSES

 * • 200 application/json
   
   Story version created
   
   Hide response attributes Show response attributes object
    * url string(url)
      
      The link url for the version
   
    * shortUrl string(url)
      
      The short link for the version
   
    * versionUrl string(url)
      
      The link to Storydoc platform for editing the version.
   
    * editorUrl string(url)
      
      The link to Storydoc platform for editing the version in the editor
      (requires Creator permissions)

 * • 400
   
   Invalid input or unsupported method.

 * • 403
   
   Request authentication failed

 * • 429
   
   Too many requests

 * • 500 application/json
   
   Internal error occured
   
   Hide response attributes Show response attributes object
    * errorId string(hex)
      
      this is the unique identifier for the issue, please save the value and
      pass to support@storydoc.com
   
    * code number
    * message string

POST /versions

curl \
 -X POST https://api.storydoc.com/v2/versions \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"daysToExpire":30,"senderEmail":"you@domain.com","data":{"title":"Prospect name","first_name":"John","last_name":"Doe","company":"ACME corporation","date":"Jan 1st 2020","link1":"https://www.storydoc.com/integrations","link2":"https://www.storydoc.com/our-story","free_text1":"This is a sample text","free_text2":"This is a sample text","title1":"Title text","title2":"Another title text","phone":"408-867-5309","email":"you@domain.com","number1":999,"number2":999,"number3":999,"number4":999,"number5":999,"number6":999}}'

Request example

{
  "daysToExpire": 30,
  "senderEmail": "you@domain.com",
  "data": {
    "title": "Prospect name",
    "first_name": "John",
    "last_name": "Doe",
    "company": "ACME corporation",
    "date": "Jan 1st 2020",
    "link1": "https://www.storydoc.com/integrations",
    "link2": "https://www.storydoc.com/our-story",
    "free_text1": "This is a sample text",
    "free_text2": "This is a sample text",
    "title1": "Title text",
    "title2": "Another title text",
    "phone": "408-867-5309",
    "email": "you@domain.com",
    "number1": 999,
    "number2": 999,
    "number3": 999,
    "number4": 999,
    "number5": 999,
    "number6": 999
  }
}

Response examples (200)

{
  "url": "https://www.storydoc.com/5d7d8922e00d9265/2e91b144-092f-456b-8f2e-0bae9f7f3355/61b1f40a3a86b7a96d0d8ccc?utm_source=storydoc&utm_medium=hp&utm_campaign=testt1&utm_content=00u24mxwu1OOcGQps5d7",
  "shortUrl": "https://view.storydoc.com/4GdDGt",
  "versionUrl": "https://app.storydoc.com/pages/editor/61b1e50223b713000a41ca74/61b1f40a3a86b7a96d0d8ccc",
  "editorUrl": "https://app.storydoc.com/pages/editor/61b1e50223b713000a41ca74/versions/61b1f40a3a86b7a96d0d8ccc"
}

Response examples (500)

{
  "errorId": "string",
  "code": 42.0,
  "message": "string"
}