Storydoc API

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"
}