Create Schedule
curl --request POST \
--url https://app.magna.so/api/external/v1/schedules/create \
--header 'Content-Type: application/json' \
--header 'x-magna-api-token: <api-key>' \
--data '
{
"tokenId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"unlockAtStart": 123,
"cliff": {
"value": 1,
"duration": 123
},
"roundingMode": "FLOOR",
"pieces": [
{
"name": "<string>",
"portion": 123,
"startDelay": {
"value": 123
},
"oneOffPieceConfiguration": {
"offset": {
"value": 123
},
"dayOfMonth": 123
},
"periodicPieceConfiguration": {
"length": {
"value": 123
},
"frequency": {
"value": 123
},
"dayOfMonth": 123
}
}
]
}
'import requests
url = "https://app.magna.so/api/external/v1/schedules/create"
payload = {
"tokenId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"unlockAtStart": 123,
"cliff": {
"value": 1,
"duration": 123
},
"roundingMode": "FLOOR",
"pieces": [
{
"name": "<string>",
"portion": 123,
"startDelay": { "value": 123 },
"oneOffPieceConfiguration": {
"offset": { "value": 123 },
"dayOfMonth": 123
},
"periodicPieceConfiguration": {
"length": { "value": 123 },
"frequency": { "value": 123 },
"dayOfMonth": 123
}
}
]
}
headers = {
"x-magna-api-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-magna-api-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tokenId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
description: '<string>',
unlockAtStart: 123,
cliff: {value: 1, duration: 123},
roundingMode: 'FLOOR',
pieces: [
{
name: '<string>',
portion: 123,
startDelay: {value: 123},
oneOffPieceConfiguration: {offset: {value: 123}, dayOfMonth: 123},
periodicPieceConfiguration: {length: {value: 123}, frequency: {value: 123}, dayOfMonth: 123}
}
]
})
};
fetch('https://app.magna.so/api/external/v1/schedules/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.magna.so/api/external/v1/schedules/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'tokenId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'description' => '<string>',
'unlockAtStart' => 123,
'cliff' => [
'value' => 1,
'duration' => 123
],
'roundingMode' => 'FLOOR',
'pieces' => [
[
'name' => '<string>',
'portion' => 123,
'startDelay' => [
'value' => 123
],
'oneOffPieceConfiguration' => [
'offset' => [
'value' => 123
],
'dayOfMonth' => 123
],
'periodicPieceConfiguration' => [
'length' => [
'value' => 123
],
'frequency' => [
'value' => 123
],
'dayOfMonth' => 123
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-magna-api-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.magna.so/api/external/v1/schedules/create"
payload := strings.NewReader("{\n \"tokenId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"unlockAtStart\": 123,\n \"cliff\": {\n \"value\": 1,\n \"duration\": 123\n },\n \"roundingMode\": \"FLOOR\",\n \"pieces\": [\n {\n \"name\": \"<string>\",\n \"portion\": 123,\n \"startDelay\": {\n \"value\": 123\n },\n \"oneOffPieceConfiguration\": {\n \"offset\": {\n \"value\": 123\n },\n \"dayOfMonth\": 123\n },\n \"periodicPieceConfiguration\": {\n \"length\": {\n \"value\": 123\n },\n \"frequency\": {\n \"value\": 123\n },\n \"dayOfMonth\": 123\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-magna-api-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.magna.so/api/external/v1/schedules/create")
.header("x-magna-api-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"tokenId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"unlockAtStart\": 123,\n \"cliff\": {\n \"value\": 1,\n \"duration\": 123\n },\n \"roundingMode\": \"FLOOR\",\n \"pieces\": [\n {\n \"name\": \"<string>\",\n \"portion\": 123,\n \"startDelay\": {\n \"value\": 123\n },\n \"oneOffPieceConfiguration\": {\n \"offset\": {\n \"value\": 123\n },\n \"dayOfMonth\": 123\n },\n \"periodicPieceConfiguration\": {\n \"length\": {\n \"value\": 123\n },\n \"frequency\": {\n \"value\": 123\n },\n \"dayOfMonth\": 123\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.magna.so/api/external/v1/schedules/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-magna-api-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tokenId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"unlockAtStart\": 123,\n \"cliff\": {\n \"value\": 1,\n \"duration\": 123\n },\n \"roundingMode\": \"FLOOR\",\n \"pieces\": [\n {\n \"name\": \"<string>\",\n \"portion\": 123,\n \"startDelay\": {\n \"value\": 123\n },\n \"oneOffPieceConfiguration\": {\n \"offset\": {\n \"value\": 123\n },\n \"dayOfMonth\": 123\n },\n \"periodicPieceConfiguration\": {\n \"length\": {\n \"value\": 123\n },\n \"frequency\": {\n \"value\": 123\n },\n \"dayOfMonth\": 123\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"isProcessed": true,
"result": {
"id": "sch...uuid",
"key": "S-ABC123",
"name": "4y monthly, 1y cliff",
"description": null,
"unlockAtStart": null,
"cliff": {
"value": 0,
"duration": 1,
"period": "YEAR"
},
"roundingMode": "FLOOR",
"createdAt": "2024-04-15T21:26:21.000Z"
}
}Schedules
Create Schedule
Create an unlock schedule for a token, with an optional cliff and one or more schedule pieces.
POST
/
api
/
external
/
v1
/
schedules
/
create
Create Schedule
curl --request POST \
--url https://app.magna.so/api/external/v1/schedules/create \
--header 'Content-Type: application/json' \
--header 'x-magna-api-token: <api-key>' \
--data '
{
"tokenId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"unlockAtStart": 123,
"cliff": {
"value": 1,
"duration": 123
},
"roundingMode": "FLOOR",
"pieces": [
{
"name": "<string>",
"portion": 123,
"startDelay": {
"value": 123
},
"oneOffPieceConfiguration": {
"offset": {
"value": 123
},
"dayOfMonth": 123
},
"periodicPieceConfiguration": {
"length": {
"value": 123
},
"frequency": {
"value": 123
},
"dayOfMonth": 123
}
}
]
}
'import requests
url = "https://app.magna.so/api/external/v1/schedules/create"
payload = {
"tokenId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"unlockAtStart": 123,
"cliff": {
"value": 1,
"duration": 123
},
"roundingMode": "FLOOR",
"pieces": [
{
"name": "<string>",
"portion": 123,
"startDelay": { "value": 123 },
"oneOffPieceConfiguration": {
"offset": { "value": 123 },
"dayOfMonth": 123
},
"periodicPieceConfiguration": {
"length": { "value": 123 },
"frequency": { "value": 123 },
"dayOfMonth": 123
}
}
]
}
headers = {
"x-magna-api-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-magna-api-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tokenId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
description: '<string>',
unlockAtStart: 123,
cliff: {value: 1, duration: 123},
roundingMode: 'FLOOR',
pieces: [
{
name: '<string>',
portion: 123,
startDelay: {value: 123},
oneOffPieceConfiguration: {offset: {value: 123}, dayOfMonth: 123},
periodicPieceConfiguration: {length: {value: 123}, frequency: {value: 123}, dayOfMonth: 123}
}
]
})
};
fetch('https://app.magna.so/api/external/v1/schedules/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.magna.so/api/external/v1/schedules/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'tokenId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'description' => '<string>',
'unlockAtStart' => 123,
'cliff' => [
'value' => 1,
'duration' => 123
],
'roundingMode' => 'FLOOR',
'pieces' => [
[
'name' => '<string>',
'portion' => 123,
'startDelay' => [
'value' => 123
],
'oneOffPieceConfiguration' => [
'offset' => [
'value' => 123
],
'dayOfMonth' => 123
],
'periodicPieceConfiguration' => [
'length' => [
'value' => 123
],
'frequency' => [
'value' => 123
],
'dayOfMonth' => 123
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-magna-api-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.magna.so/api/external/v1/schedules/create"
payload := strings.NewReader("{\n \"tokenId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"unlockAtStart\": 123,\n \"cliff\": {\n \"value\": 1,\n \"duration\": 123\n },\n \"roundingMode\": \"FLOOR\",\n \"pieces\": [\n {\n \"name\": \"<string>\",\n \"portion\": 123,\n \"startDelay\": {\n \"value\": 123\n },\n \"oneOffPieceConfiguration\": {\n \"offset\": {\n \"value\": 123\n },\n \"dayOfMonth\": 123\n },\n \"periodicPieceConfiguration\": {\n \"length\": {\n \"value\": 123\n },\n \"frequency\": {\n \"value\": 123\n },\n \"dayOfMonth\": 123\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-magna-api-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.magna.so/api/external/v1/schedules/create")
.header("x-magna-api-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"tokenId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"unlockAtStart\": 123,\n \"cliff\": {\n \"value\": 1,\n \"duration\": 123\n },\n \"roundingMode\": \"FLOOR\",\n \"pieces\": [\n {\n \"name\": \"<string>\",\n \"portion\": 123,\n \"startDelay\": {\n \"value\": 123\n },\n \"oneOffPieceConfiguration\": {\n \"offset\": {\n \"value\": 123\n },\n \"dayOfMonth\": 123\n },\n \"periodicPieceConfiguration\": {\n \"length\": {\n \"value\": 123\n },\n \"frequency\": {\n \"value\": 123\n },\n \"dayOfMonth\": 123\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.magna.so/api/external/v1/schedules/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-magna-api-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tokenId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"unlockAtStart\": 123,\n \"cliff\": {\n \"value\": 1,\n \"duration\": 123\n },\n \"roundingMode\": \"FLOOR\",\n \"pieces\": [\n {\n \"name\": \"<string>\",\n \"portion\": 123,\n \"startDelay\": {\n \"value\": 123\n },\n \"oneOffPieceConfiguration\": {\n \"offset\": {\n \"value\": 123\n },\n \"dayOfMonth\": 123\n },\n \"periodicPieceConfiguration\": {\n \"length\": {\n \"value\": 123\n },\n \"frequency\": {\n \"value\": 123\n },\n \"dayOfMonth\": 123\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"isProcessed": true,
"result": {
"id": "sch...uuid",
"key": "S-ABC123",
"name": "4y monthly, 1y cliff",
"description": null,
"unlockAtStart": null,
"cliff": {
"value": 0,
"duration": 1,
"period": "YEAR"
},
"roundingMode": "FLOOR",
"createdAt": "2024-04-15T21:26:21.000Z"
}
}Authorizations
Body
application/json
Minimum string length:
1Minimum string length:
1Minimum string length:
1Show child attributes
Show child attributes
Available options:
FLOOR Show child attributes
Show child attributes
⌘I