Skip to main content
POST
/
api
/
external
/
v1
/
allocations
/
create
Create Allocation
curl --request POST \
  --url https://app.magna.so/api/external/v1/allocations/create \
  --header 'Content-Type: application/json' \
  --header 'x-magna-api-token: <api-key>' \
  --data '
{
  "amount": 123,
  "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tokenId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "stakeholder": {
    "name": "<string>",
    "email": "[email protected]",
    "xHandle": "<string>",
    "employeeNumber": "<string>"
  },
  "category": "<string>",
  "key": "<string>",
  "description": "<string>",
  "unlockScheduleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "unlockStartAt": "<string>",
  "vestingScheduleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vestingStartAt": "<string>",
  "walletAddress": "<string>",
  "receivedOffMagna": 123,
  "cancellable": true,
  "projectWalletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customAttributes": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}
'
{
  "isProcessed": true,
  "result": {
    "id": "becf2391-0b8b-4bdf-ae4a-fb6c0d103554",
    "key": "A-DC574CI5YB",
    "amount": "50000",
    "receivedOffMagna": null,
    "funded": null,
    "received": "0",
    "state": "NOT_STARTED",
    "status": "NOT_STARTED",
    "isWalletSubmitted": null,
    "releaseMode": null,
    "description": "Employee equity allocation",
    "releasable": "0",
    "claimable": null,
    "pendingRelease": null,
    "vaultId": null,
    "grantId": null,
    "custodyType": "CONTRACT",
    "projectId": "c74e6bdb-f496-42c7-aaa7-be184ee64913",
    "tokenId": "054d0c03-d20e-477e-81c0-9c2e4453d4a6",
    "stakeholderId": "38f390cc-6e37-46e4-97c1-8a80ca282519",
    "walletId": "d20b6cc1-76f8-46cb-b196-d7eeb872ebf2",
    "categoryId": "61650035-a002-4367-b470-e4cd04209492",
    "createdAt": "2025-07-30T11:15:24.327Z",
    "updatedAt": "2025-07-30T11:15:24.327Z",
    "cancelledAt": null,
    "scheduledCancelAt": null,
    "unlockScheduleId": "6ef4a3b5-eaa7-4158-9dea-557d4715a72c",
    "unlockStartAt": "2024-04-15T00:00:00.000Z",
    "vestingScheduleId": null,
    "vestingStartAt": null
  }
}

Authorizations

x-magna-api-token
string
header
required

Body

application/json
amount
number
required
contractId
string<uuid>
required
Minimum string length: 1
tokenId
string<uuid>
required
Minimum string length: 1
stakeholder
object
required
category
string
required
Minimum string length: 1
key
string
Minimum string length: 1
description
string
Minimum string length: 1
unlockScheduleId
string<uuid>
Minimum string length: 1
unlockStartAt
string
Minimum string length: 1
vestingScheduleId
string<uuid>
Minimum string length: 1
vestingStartAt
string
Minimum string length: 1
releaseMode
enum<string>
Available options:
MIXED,
VEST_AFTER_UNLOCK
walletAddress
string
Minimum string length: 1
receivedOffMagna
number
cancellable
boolean
projectWalletId
string<uuid>
Minimum string length: 1
customAttributes
object[]

Response

Successful response

isProcessed
boolean
result
any

Endpoint-specific result payload.