Skip to main content
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
      }
    }
  ]
}
'
{
  "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

x-magna-api-token
string
header
required

Body

application/json
tokenId
string<uuid>
required
Minimum string length: 1
name
string | null
Minimum string length: 1
description
string | null
Minimum string length: 1
unlockAtStart
number | null
cliff
object
roundingMode
enum<string> | null
Available options:
FLOOR
pieces
object[] | null

Response

Successful response

isProcessed
boolean
result
any

Endpoint-specific result payload.