> ## Documentation Index
> Fetch the complete documentation index at: https://docs.magna.so/llms.txt
> Use this file to discover all available pages before exploring further.

# Modify Allocation



## OpenAPI

````yaml /apis/admin/openapi.json post /api/external/v1/allocations/{id}/modify
openapi: 3.1.0
info:
  title: Magna Admin API
  version: 1.0.0
  description: >-
    The private, server-to-server API for managing allocations, funding and
    claims, transactions, portals, and token data. Authenticated with a project
    API key sent in the `x-magna-api-token` header.
servers:
  - url: https://app.magna.so
    description: Production
security:
  - apiToken: []
paths:
  /api/external/v1/allocations/{id}/modify:
    post:
      tags:
        - Allocations
      summary: Modify Allocation
      operationId: postAllocationsByIdModify
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type:
              - string
            minLength: 1
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type:
                - object
              properties:
                hideAllocationFromPortal:
                  type:
                    - boolean
                walletAddress:
                  type:
                    - string
                  minLength: 1
                customAttributes:
                  type:
                    - array
                  items:
                    type:
                      - object
                    properties:
                      key:
                        type:
                          - string
                        minLength: 1
                      value:
                        type:
                          - string
                        minLength: 1
                    required:
                      - key
                      - value
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  isProcessed:
                    type: boolean
                  result:
                    description: Endpoint-specific result payload.
              example:
                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'
        '400':
          description: Validation error
        '401':
          description: Missing or invalid API token
        '403':
          description: API token lacks the required scope or project access
components:
  securitySchemes:
    apiToken:
      type: apiKey
      in: header
      name: x-magna-api-token

````