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

# Toggle creditor block status

> Block or unblock a creditor company. Blocking prevents creditor login and queues the blocked-account notification email when an owner email is available.



## OpenAPI

````yaml /api/superadmin.openapi.yaml patch /manage-creditors/{company}/block-status
openapi: 3.1.0
info:
  title: YouNegotiate Superadmin API
  version: '2.0'
  description: Stateless API endpoints for the Superadmin portal.
servers:
  - url: https://api.hub.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public superadmin domain system and health endpoints.
  - name: Authentication
    description: Superadmin login, logout, password reset, and password change endpoints.
  - name: Profile
    description: Authenticated superadmin profile endpoints.
  - name: Admin Configuration
    description: Platform configuration values and feature flag controls.
  - name: MailHub Users
    description: Superadmin management for EcoMail Hub / EcoPortal users.
  - name: Super Admin Users
    description: Superadmin management for platform operations users.
  - name: Consumers
    description: Superadmin consumer account list, detail, filter, and export endpoints.
  - name: Creditors
    description: Superadmin creditor account list and account access endpoints.
  - name: Sub Accounts
    description: Superadmin sub account list and export endpoints.
  - name: Reseller Partners
    description: Superadmin reseller partner list and report-history endpoints.
  - name: Special Plan Inquiries
    description: >-
      Superadmin special membership inquiry list, detail, resolve, and close
      endpoints.
  - name: Plans
    description: >-
      Superadmin membership plan list, create, update, reorder, visibility, and
      delete endpoints.
  - name: Failed - Canceled
    description: Superadmin failed or cancelled membership list and custom email endpoints.
  - name: Merchant Requests
    description: >-
      Superadmin merchant API request list, export, email, forwarding, progress,
      and approval endpoints.
  - name: Bill Pay Donations
    description: Superadmin Bill Pay gift donation list, export, and receipt endpoints.
  - name: Export & Reporting
    description: Superadmin generated report options and CSV download endpoints.
  - name: Communications / Templates
    description: >-
      Superadmin email and SMS template management for manual communications and
      campaigns.
  - name: Communications / Groups
    description: >-
      Superadmin communication group management for dynamic consumer targeting
      and campaign selection.
  - name: Communications / Schedule Campaign
    description: >-
      Superadmin email and SMS campaign scheduling, immediate send, and delivery
      queue endpoints.
  - name: Communications / Campaign Tracker
    description: >-
      Superadmin campaign tracker snapshots, refresh actions, and consumer
      exports.
  - name: Automated Communications
    description: >-
      Superadmin automated email/SMS templates, trigger configuration, and
      delivery history endpoints.
paths:
  /manage-creditors/{company}/block-status:
    patch:
      tags:
        - Creditors
      summary: Toggle creditor block status
      description: >-
        Block or unblock a creditor company. Blocking prevents creditor login
        and queues the blocked-account notification email when an owner email is
        available.
      operationId: superadminToggleCreditorBlockStatus
      parameters:
        - name: company
          in: path
          required: true
          description: Creditor company ID.
          schema:
            type: integer
      responses:
        '200':
          description: Creditor company block status updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperadminCreditorResponse'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
        - bearerAuth: []
components:
  schemas:
    SuperadminCreditorResponse:
      type: object
      required:
        - message
        - data
      properties:
        message:
          type: string
          example: Acme Recovery blocked. Users cannot log in.
        data:
          $ref: '#/components/schemas/SuperadminCreditor'
    SuperadminCreditor:
      allOf:
        - $ref: '#/components/schemas/SuperadminCreditorBase'
        - type: object
          properties:
            actions:
              type: object
              required:
                - can_block
                - can_unblock
                - can_export_consumers
                - can_send_email
                - can_login_as
                - can_delete
                - can_view_profile
              properties:
                can_block:
                  type: boolean
                can_unblock:
                  type: boolean
                can_export_consumers:
                  type: boolean
                can_send_email:
                  type: boolean
                can_login_as:
                  type: boolean
                can_delete:
                  type: boolean
                can_view_profile:
                  type: boolean
            action_items:
              type: array
              items:
                type: object
                required:
                  - key
                  - label
                  - available
                properties:
                  key:
                    type: string
                    enum:
                      - block
                      - unblock
                      - export_consumers
                      - send_email
                      - login_as
                      - delete
                      - view_profile
                      - no_action
                  label:
                    type: string
                  available:
                    type: boolean
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    SuperadminCreditorBase:
      type: object
      additionalProperties: true
      properties:
        id:
          type: integer
        company_name:
          type: string
          nullable: true
        company_type:
          type: object
          required:
            - value
            - label
          properties:
            value:
              type: string
              nullable: true
              example: debt-buyer
            label:
              type: string
              example: Debt Buyer
        contact:
          type: object
          required:
            - name
            - email
          properties:
            name:
              type: string
              nullable: true
            email:
              type: string
              format: email
              nullable: true
        root_creditor:
          type:
            - object
            - 'null'
          properties:
            id:
              type: integer
            name:
              type: string
              nullable: true
            email:
              type: string
              format: email
              nullable: true
        recipient:
          type: object
          required:
            - name
            - email
          properties:
            name:
              type: string
              nullable: true
            email:
              type: string
              format: email
              nullable: true
        status_badge:
          type: object
          required:
            - value
            - label
            - tooltip
          properties:
            value:
              type: string
              enum:
                - AM
                - PM
                - FP
                - U
                - CN
                - blocked
            label:
              type: string
              example: AM
            tooltip:
              type: string
              nullable: true
              example: Active Member
        membership:
          type: object
          required:
            - plan_name
            - upload_accounts_limit
          properties:
            plan_name:
              type: string
              nullable: true
            upload_accounts_limit:
              type: integer
              nullable: true
        consumer_stats_loaded:
          type: boolean
        consumers_count:
          type: integer
          nullable: true
        total_balance:
          type: number
          format: float
          nullable: true
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
        deleted_at:
          type: string
          format: date-time
          nullable: true
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum token

````