Skip to main content
POST
/
api
/
external
/
v1
/
allocations
/
{id}
/
modify
Modify Allocation
curl --request POST \
  --url https://app.magna.so/api/external/v1/allocations/{id}/modify \
  --header 'Content-Type: application/json' \
  --header 'x-magna-api-token: <api-key>' \
  --data '
{
  "hideAllocationFromPortal": true,
  "walletAddress": "<string>",
  "customAttributes": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}
'
{
  "isProcessed": true,
  "result": {
    "id": "7eb179c5-d86a-4c0c-be29-198ad0cb39b0",
    "key": "A-SMJ7LTO1GS",
    "description": null,
    "amount": "12000",
    "funded": "0",
    "received": "0",
    "walletAddress": "0x01f9632EA55Aa14eD6B39aA8EbCEcE425f7ef0e9",
    "createdAt": "2024-04-15T21:26:21.000Z",
    "updatedAt": "2024-04-15T21:26:21.000Z",
    "cancelledAt": null,
    "state": "NOT_STARTED",
    "stakeholder": {
      "id": "fe2d5104-36d5-4c79-b457-6bfcb1ae498c",
      "type": null,
      "employeeNumber": null,
      "name": null,
      "contactEmail": null
    },
    "customAttributes": [
      {
        "key": "department",
        "value": "Engineering"
      },
      {
        "key": "employeeLevel",
        "value": "Senior"
      }
    ],
    "category": {
      "id": "3451cadc-dd25-4aee-b000-453756796a06",
      "name": "Category-Name"
    },
    "unlockStartAt": "2024-04-15T21:26:21.000Z",
    "vestingStartAt": "2024-04-15T21:26:21.000Z"
  }
}

Authorizations

x-magna-api-token
string
header
required

Path Parameters

id
string<uuid>
required
Minimum string length: 1

Body

application/json
hideAllocationFromPortal
boolean
walletAddress
string
Minimum string length: 1
customAttributes
object[]

Response

Successful response

isProcessed
boolean
result
any

Endpoint-specific result payload.