Tag Bulk Association

This endpoint is used to add a tag to multiple stories at once.

https://mapi.storyblok.com/v1/spaces/:space-id/tags/bulk_association

Path Parameters

:space_id
required number

Numeric ID of a space

Request Body Properties

idea
The Ideation Room Object

An array of objects, with each object consisting of a story_id of the story you want to add tags to, and a tag_list property as an array of tag names.
- name
  required string
  
  Name of the Idea
- description
  string
  
  A description of your Idea
- content
  object
  
  The content of your Idea
- created_at
  string
  
  Creation date (Format: yyyy-MM-dd'T'HH:mm:ssZ)
- updated_at
  string
  
  Latest update date (Format: yyyy-MM-dd'T'HH:mm:ssZ)
- deleted_at
  string
  
  Deleted date (Format: YYYY-mm-dd HH:MM)
- status
  required string
  
  Status of approval
- is_private
  boolean
  
  Defines the public or private status of the idea
- bookmarks
  object
  
  The external resources URLs and their names with _uid
  - _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
  - id
    number
    
    Id of the tag
  - name
    string
    
    Name of the tag
- author
  object
  
  The author object inside an Idea
  - 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
  - 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
  - name
    string
    
    The complete name provided for the story
  - full_slug
    string
    
    The full slug of the story, combining the parent folder(s) and the designated story slug

Select a Language

Request

curl "https://mapi.storyblok.com/v1/https://mapi.storyblok.com/v1/spaces/296898/tags/bulk_association" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -d "{\"tags\": {\"stories\": [{\"story_id\": 614542121,\"tag_list\": [\"Featured article\", \"Newsroom\"]},{ \"story_id\": 614544107, \"tag_list\": [\"Blog\", \"Archive\", \"Marketing\"] },{ \"story_id\": 614543950, \"tag_list\": [\"Featured article\", \"Newsroom\"] }]}}"

Request

// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.post('/https://mapi.storyblok.com/v1/spaces/296898/tags/bulk_association', {
  "tags": {
    "stories": [
      {
        "story_id": 614542121,
        "tag_list": ["Featured article", "Newsroom"]
      },
      { "story_id": 614544107, "tag_list": ["Blog", "Archive", "Marketing"] },
      { "story_id": 614543950, "tag_list": ["Featured article", "Newsroom"] }
    ]
  }
}
)
  .then(response => {
    console.log(response)
  }).catch(error => { 
    console.log(error)
  })

Request

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

$payload = [
  "tags" =>  [
    "stories" =>  [
      [
        "story_id" =>  614542121,
        "tag_list" =>  ["Featured article", "Newsroom"]
      ],
      [ "story_id" =>  614544107, "tag_list" =>  ["Blog", "Archive", "Marketing"] ],
      [ "story_id" =>  614543950, "tag_list" =>  ["Featured article", "Newsroom"] ]
    ]
  ]
]
;

$client->post('/https://mapi.storyblok.com/v1/spaces/296898/tags/bulk_association', $payload)->getBody();

Request

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

payload = {
  "tags" =>  {
    "stories" =>  [
      {
        "story_id" =>  614542121,
        "tag_list" =>  ["Featured article", "Newsroom"]
      },
      { "story_id" =>  614544107, "tag_list" =>  ["Blog", "Archive", "Marketing"] },
      { "story_id" =>  614543950, "tag_list" =>  ["Featured article", "Newsroom"] }
    ]
  }
}


client.post('/https://mapi.storyblok.com/v1/spaces/296898/tags/bulk_association', payload)

Request

HttpResponse<String> response = Unirest.post("https://mapi.storyblok.com/v1/https://mapi.storyblok.com/v1/spaces/296898/tags/bulk_association")
  .header("Content-Type", "application/json")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .body("{\"tags\": {\"stories\": [{\"story_id\": 614542121,\"tag_list\": [\"Featured article\", \"Newsroom\"]},{ \"story_id\": 614544107, \"tag_list\": [\"Blog\", \"Archive\", \"Marketing\"] },{ \"story_id\": 614543950, \"tag_list\": [\"Featured article\", \"Newsroom\"] }]}}")
  .asString();

Request

var client = new RestClient("https://mapi.storyblok.com/v1/https://mapi.storyblok.com/v1/spaces/296898/tags/bulk_association");
var request = new RestRequest(Method.POST);

request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "{\"tags\": {\"stories\": [{\"story_id\": 614542121,\"tag_list\": [\"Featured article\", \"Newsroom\"]},{ \"story_id\": 614544107, \"tag_list\": [\"Blog\", \"Archive\", \"Marketing\"] },{ \"story_id\": 614543950, \"tag_list\": [\"Featured article\", \"Newsroom\"] }]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request

import Foundation

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

let postData = NSData(data: "{\"tags\": {\"stories\": [{\"story_id\": 614542121,\"tag_list\": [\"Featured article\", \"Newsroom\"]},{ \"story_id\": 614544107, \"tag_list\": [\"Blog\", \"Archive\", \"Marketing\"] },{ \"story_id\": 614543950, \"tag_list\": [\"Featured article\", \"Newsroom\"] }]}}".data(using: String.Encoding.utf8)!)
let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/https://mapi.storyblok.com/v1/spaces/296898/tags/bulk_association")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0)

request.method = "POST"
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()

Request

import requests

url = "https://mapi.storyblok.com/v1/https://mapi.storyblok.com/v1/spaces/296898/tags/bulk_association"

querystring = {}

payload = "{\"tags\": {\"stories\": [{\"story_id\": 614542121,\"tag_list\": [\"Featured article\", \"Newsroom\"]},{ \"story_id\": 614544107, \"tag_list\": [\"Blog\", \"Archive\", \"Marketing\"] },{ \"story_id\": 614543950, \"tag_list\": [\"Featured article\", \"Newsroom\"] }]}}"
headers = {
  'Content-Type': "application/json",
  'Authorization': "YOUR_OAUTH_TOKEN"
}

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

print(response.text)