Update an Idea

https://mapi.storyblok.com/v1/spaces/:space_id/ideas/:idea_id

Update an idea using an idea uuid. In the request body, it’s required to pass the idea object.

Path parameters

• :space_id required number

  Numeric ID of a space

• :idea_uuid required string

  Numeric uuid of an idea

Request body properties

• idea The Ideation Room Object

  A single idea object

  Show The Ideation Room Object child properties

  • name string

    Name of the Idea

  • description string

    A description of your Idea

  • content object

    The content of your Idea

  • deleted_at string

    Deleted date (Format: YYYY-mm-dd HH:MM)

  • status string

    Status of approval

  • story_ids number[]

    List of story IDs

  • is_private boolean

    Defines the public or private status of the idea

  • bookmarks object

    The external resources URLs and their names with _uid

    Show child properties

    • _uid string

      UUID

    • link string

      The string value of the URL from Idea’s external resources.

    • label string

      The string value of the name of the external resource URL in the Idea.

  • internal_tags_list object[]

    List of objects containing the details of tags used for the component

    Show child properties

    • id number

      Id of the tag

    • name string

      Name of the tag

  • internal_tag_ids string[]

    List of ids of the tags assigned to the component

  • author object

    The author object inside an Idea

    Show child properties

    • id number

      The numeric ID

    • avatar string

      Avatar of collaborator usually an image

    • userid string

      User ID of collaborator

    • friendly_name string

      Friendly name of collaborator

  • assignee object

    The assignee object inside an Idea

    Show child properties

    • id number

      The numeric ID

    • avatar string

      Avatar of collaborator usually an image

    • userid string

      User ID of collaborator

    • friendly_name string

      Friendly name of collaborator

  • stories Idea's Stories Object

    An array of the idea’s stories object

    Show child properties

    • name string

      The complete name provided for the story

    • id number

      The numeric ID

    • full_slug string

      The full slug of the story, combining the parent folder(s) and the designated story slug

Response properties

• idea The Ideation Room Object

  A single idea object

Examples

cURL

curl "https://mapi.storyblok.com/v1/spaces/606/ideas/ab123cd4-5e6f-7gh8-9ij1-01k112l13m1n" \
  -X PUT \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"idea\":{\"assignee\":null,\"author\":{\"avatar\":\"avatars/67891/838dcb304c/avatar.jpg\",\"friendly_name\":\"Jon Doe\",\"id\":67891,\"userid\":\"test@email.com\"},\"bookmarks\":[],\"content\":{},\"deleted_at\":null,\"description\":\"First idea\",\"internal_tag_ids\":[\"12345\"],\"internal_tags_list\":[{\"id\":12345,\"name\":\"docs\"}],\"is_private\":true,\"name\":\"My first idea\",\"status\":\"draft\",\"stories\":[],\"story_ids\":[]}}"

JS client

// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.put('spaces/606/ideas/ab123cd4-5e6f-7gh8-9ij1-01k112l13m1n', {
  "idea": {
    "assignee": null,
    "author": {
      "avatar": "avatars/67891/838dcb304c/avatar.jpg",
      "friendly_name": "Jon Doe",
      "id": 67891,
      "userid": "test@email.com"
    },
    "bookmarks": [],
    "content": {},
    "deleted_at": null,
    "description": "First idea",
    "internal_tag_ids": [
      "12345"
    ],
    "internal_tags_list": [
      {
        "id": 12345,
        "name": "docs"
      }
    ],
    "is_private": true,
    "name": "My first idea",
    "status": "draft",
    "stories": [],
    "story_ids": []
  }
})
  .then(response => {
    console.log(response)
  }).catch(error => {
    console.log(error)
  })

PHP client

$client = new \Storyblok\ManagementClient('YOUR_OAUTH_TOKEN');

$payload = ["idea" => ["assignee" => null,"author" => ["avatar" => "avatars/67891/838dcb304c/avatar.jpg","friendly_name" => "Jon Doe","id" => 67891,"userid" => "test@email.com"],"bookmarks" => [],"content" => [],"deleted_at" => null,"description" => "First idea","internal_tag_ids" => ["12345"],"internal_tags_list" => [["id" => 12345,"name" => "docs"]],"is_private" => true,"name" => "My first idea","status" => "draft","stories" => [],"story_ids" => []]];

$client->put('spaces/606/ideas/ab123cd4-5e6f-7gh8-9ij1-01k112l13m1n', $payload)->getBody();

Java

HttpResponse<String> response = Unirest.put("https://mapi.storyblok.com/v1/spaces/606/ideas/ab123cd4-5e6f-7gh8-9ij1-01k112l13m1n")
  .header("Content-Type", "application/json")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .body({"idea":{"assignee":null,"author":{"avatar":"avatars/67891/838dcb304c/avatar.jpg","friendly_name":"Jon Doe","id":67891,"userid":"test@email.com"},"bookmarks":[],"content":{},"deleted_at":null,"description":"First idea","internal_tag_ids":["12345"],"internal_tags_list":[{"id":12345,"name":"docs"}],"is_private":true,"name":"My first idea","status":"draft","stories":[],"story_ids":[]}})
  .asString();

C#

var client = new RestClient("https://mapi.storyblok.com/v1/spaces/606/ideas/ab123cd4-5e6f-7gh8-9ij1-01k112l13m1n");
var request = new RestRequest(Method.PUT);

request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "{\"idea\":{\"assignee\":null,\"author\":{\"avatar\":\"avatars/67891/838dcb304c/avatar.jpg\",\"friendly_name\":\"Jon Doe\",\"id\":67891,\"userid\":\"test@email.com\"},\"bookmarks\":[],\"content\":{},\"deleted_at\":null,\"description\":\"First idea\",\"internal_tag_ids\":[\"12345\"],\"internal_tags_list\":[{\"id\":12345,\"name\":\"docs\"}],\"is_private\":true,\"name\":\"My first idea\",\"status\":\"draft\",\"stories\":[],\"story_ids\":[]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Python

import requests

url = "https://mapi.storyblok.com/v1/spaces/606/ideas/ab123cd4-5e6f-7gh8-9ij1-01k112l13m1n"

querystring = {}

payload = {"idea":{"assignee":null,"author":{"avatar":"avatars/67891/838dcb304c/avatar.jpg","friendly_name":"Jon Doe","id":67891,"userid":"test@email.com"},"bookmarks":[],"content":{},"deleted_at":null,"description":"First idea","internal_tag_ids":["12345"],"internal_tags_list":[{"id":12345,"name":"docs"}],"is_private":true,"name":"My first idea","status":"draft","stories":[],"story_ids":[]}}
headers = {
  'Content-Type': "application/json",
  'Authorization': "YOUR_OAUTH_TOKEN"
}

response = requests.request("PUT", url, data=payload, headers=headers, params=querystring)

print(response.text)

Ruby

require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')

payload = {"idea" => {"assignee" => null,"author" => {"avatar" => "avatars/67891/838dcb304c/avatar.jpg","friendly_name" => "Jon Doe","id" => 67891,"userid" => "test@email.com"},"bookmarks" => [],"content" => {},"deleted_at" => null,"description" => "First idea","internal_tag_ids" => ["12345"],"internal_tags_list" => [{"id" => 12345,"name" => "docs"}],"is_private" => true,"name" => "My first idea","status" => "draft","stories" => [],"story_ids" => []}}

client.put('spaces/606/ideas/ab123cd4-5e6f-7gh8-9ij1-01k112l13m1n', payload)

Swift

import Foundation

let headers = [
  "Content-Type": "application/json",
  "Authorization": "YOUR_OAUTH_TOKEN"
]

let postData = NSData(data: {"idea":{"assignee":null,"author":{"avatar":"avatars/67891/838dcb304c/avatar.jpg","friendly_name":"Jon Doe","id":67891,"userid":"test@email.com"},"bookmarks":[],"content":{},"deleted_at":null,"description":"First idea","internal_tag_ids":["12345"],"internal_tags_list":[{"id":12345,"name":"docs"}],"is_private":true,"name":"My first idea","status":"draft","stories":[],"story_ids":[]}}.data(using: String.Encoding.utf8)!)

let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/spaces/606/ideas/ab123cd4-5e6f-7gh8-9ij1-01k112l13m1n")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0)
request.method = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()