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

# Suspend a sub-custodian

> Suspends a sub-custodian owned by the authenticated reseller.
Suspension blocks that custodian's Portal dashboard users, Portal API keys,
client API keys, client session tokens, and service-authenticated requests.




## OpenAPI

````yaml /openapi/reseller-api.yaml put /resellers/custodians/{custodianId}/suspend
openapi: 3.1.0
info:
  title: Portal Reseller API
  version: '3.0'
  description: >
    The Portal Reseller API lets approved reseller custodians create and manage

    sub-custodians. Reseller API keys are environment-agnostic and authenticate

    the reseller custodian. Sub-custodian Portal API keys created through this
    API

    are scoped to a specific sub-custodian environment.


    ## Base URL

    `https://api.portalhq.io/api/v3`


    ## Authentication

    Include your Reseller API key as a Bearer token in the `Authorization`
    header

    of every request.
servers:
  - url: https://api.portalhq.io/api/v3
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Sub-Custodians
    description: Create, list, and suspend sub-custodians
  - name: Sub-Custodian Environments
    description: View environments for sub-custodians
  - name: Sub-Custodian API Keys
    description: Create and delete sub-custodian Portal API keys
paths:
  /resellers/custodians/{custodianId}/suspend:
    put:
      tags:
        - Sub-Custodians
      summary: Suspend a sub-custodian
      description: >
        Suspends a sub-custodian owned by the authenticated reseller.

        Suspension blocks that custodian's Portal dashboard users, Portal API
        keys,

        client API keys, client session tokens, and service-authenticated
        requests.
      operationId: suspendSubCustodian
      parameters:
        - $ref: '#/components/parameters/custodianId'
      responses:
        '200':
          description: Sub-custodian suspended successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubCustodian'
              example:
                id: custodian_123
                name: Acme Payments
                slug: acme-payments
                billingStatus: SUSPENDED
                isReseller: false
                resellerParentId: reseller_custodian_123
                sessionTokensEnabled: true
                createdAt: '2026-07-08T18:00:00.000Z'
                updatedAt: '2026-07-08T18:15:00.000Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    custodianId:
      name: custodianId
      in: path
      required: true
      description: The ID of a sub-custodian owned by the authenticated reseller.
      schema:
        type: string
  schemas:
    SubCustodian:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        slug:
          type: string
        billingStatus:
          type: string
          enum:
            - ACTIVE
            - HACKATHON
            - INACTIVE
            - INTERNAL
            - SUSPENDED
            - TRIAL
        isReseller:
          type: boolean
        resellerParentId:
          type: string
          nullable: true
        sessionTokensEnabled:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        billingPlan:
          $ref: '#/components/schemas/BillingPlan'
        environments:
          type: array
          items:
            $ref: '#/components/schemas/Environment'
        users:
          type: array
          items:
            $ref: '#/components/schemas/User'
        apiKeys:
          type: array
          items:
            $ref: '#/components/schemas/SubCustodianApiKeyMetadata'
    BillingPlan:
      type: object
      properties:
        name:
          type: string
    Environment:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
          enum:
            - Development
            - Production
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    User:
      type: object
      properties:
        id:
          type: string
        email:
          type: string
          format: email
        firstName:
          type: string
          nullable: true
        lastName:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    SubCustodianApiKeyMetadata:
      type: object
      properties:
        id:
          type: string
        custodianId:
          type: string
        environmentId:
          type: string
        name:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
  responses:
    Unauthorized:
      description: Unauthorized - invalid or missing Reseller API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: >-
        Forbidden - the authenticated custodian is not allowed to perform this
        action
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Reseller API Key
      description: Reseller API key created in the Portal dashboard.

````