Create a Branch
This endpoint creates a new branch.
https://mapi.storyblok.com/v1/spaces/:space_id/branches/
Path Parameters
-
:space_id
required numberNumeric ID of a space
Request Body Properties
-
branch
The Branch Object-
name
required stringBranch Name
-
source_id
number or nullSource of this branch
null
orid
of another branch -
url
stringPreview URL for this branch
-
position
numberNumeric representation of the branch position
-
Response Properties
-
branch
The Branch Object-
id
numberBranch ID
-
name
stringBranch Name
-
space_id
numberNumeric ID of a space
-
deleted_at
stringDeleted date (Format: YYYY-mm-dd HH:MM)
-
created_at
stringCreation date (Format:
yyyy-MM-dd'T'HH:mm:ssZ
) -
updated_at
stringLatest update date (Format:
yyyy-MM-dd'T'HH:mm:ssZ
) -
source_id
number or nullSource of this branch
null
orid
of another branch -
deployed_at
stringDeployed date (Format:
yyyy-MM-dd'T'HH:mm:ssZ
) -
url
stringPreview URL for this branch
-
position
numberNumeric representation of the branch position
-
curl "https://mapi.storyblok.com/v1/spaces/606/branches/" \
-X POST \
-H "Content-Type: application/json" \
-H "Authorization: YOUR_OAUTH_TOKEN" \
-d "{\"branch\": {\"name\": \"A new branch\",\"position\": 2,\"url\": \"https://new_domain.com\",\"source_id\" : 12332}}"
// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.post('/spaces/606/branches/', {
"branch": {
"name": "A new branch",
"position": 2,
"url": "https://new_domain.com",
"source_id" : 12332
}
})
.then(response => {
console.log(response)
}).catch(error => {
console.log(error)
})
$client = new \Storyblok\ManagementClient('YOUR_OAUTH_TOKEN');
$payload = [
"branch" => [
"name" => "A new branch",
"position" => 2,
"url" => "https => //new_domain.com",
"source_id" => 12332
]
];
$client->post('/spaces/606/branches/', $payload)->getBody();
require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')
payload = {
"branch" => {
"name" => "A new branch",
"position" => 2,
"url" => "https => //new_domain.com",
"source_id" => 12332
}
}
client.post('/spaces/606/branches/', payload)
HttpResponse<String> response = Unirest.post("https://mapi.storyblok.com/v1/spaces/606/branches/")
.header("Content-Type", "application/json")
.header("Authorization", "YOUR_OAUTH_TOKEN")
.body("{\"branch\": {\"name\": \"A new branch\",\"position\": 2,\"url\": \"https://new_domain.com\",\"source_id\" : 12332}}")
.asString();
var client = new RestClient("https://mapi.storyblok.com/v1/spaces/606/branches/");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "{\"branch\": {\"name\": \"A new branch\",\"position\": 2,\"url\": \"https://new_domain.com\",\"source_id\" : 12332}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
import Foundation
let headers = [
"Content-Type": "application/json",
"Authorization": "YOUR_OAUTH_TOKEN"
]
let postData = NSData(data: "{\"branch\": {\"name\": \"A new branch\",\"position\": 2,\"url\": \"https://new_domain.com\",\"source_id\" : 12332}}".data(using: String.Encoding.utf8)!)
let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/spaces/606/branches/")! 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()
import requests
url = "https://mapi.storyblok.com/v1/spaces/606/branches/"
querystring = {}
payload = "{\"branch\": {\"name\": \"A new branch\",\"position\": 2,\"url\": \"https://new_domain.com\",\"source_id\" : 12332}}"
headers = {
'Content-Type': "application/json",
'Authorization': "YOUR_OAUTH_TOKEN"
}
response = requests.request("POST", url, data=payload, headers=headers, params=querystring)
print(response.text)
You will receive a branch object as a response.