> ## 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.

# Edit creditor profile

> Return editable creditor profile form data and contacts. Active company-backed profiles return a conflict response because they are read-only.



## OpenAPI

````yaml /api/ecomailhub.openapi.yaml get /manage-creditor-profiles/{creditorProfile}/edit
openapi: 3.1.0
info:
  title: YouNegotiate EcoMail Hub API
  version: '2.0'
  description: Stateless API endpoints for EcoMail Hub / EcoPortal users.
servers:
  - url: https://api.ecomailhub.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public EcoMail Hub domain system and health endpoints.
  - name: Authentication
    description: EcoMail Hub login, logout, password reset, and password change endpoints.
  - name: Profile
    description: Authenticated EcoMail Hub user profile endpoints.
  - name: Dashboard
    description: EcoMail Hub dashboard summary and notice-response bucket endpoints.
  - name: Manage Consumers
    description: >-
      EcoMail Hub consumer identity grouping and notice-response count
      endpoints.
  - name: Manage Creditors
    description: >-
      EcoMail Hub creditor profile and company-only member profile table
      endpoints.
  - name: Import Creditor Profiles
    description: EcoMail Hub creditor profile CSV import endpoints.
  - name: Manage Notice Response
    description: >-
      EcoMail Hub top-level notice-response review, reassignment, and close
      endpoints.
  - name: Manage Users
    description: EcoMail Hub user account management endpoints.
  - name: Reports
    description: EcoMail Hub one-time and scheduled CSV report endpoints.
  - name: Communications
    description: EcoMail Hub communication template editor endpoints.
paths:
  /manage-creditor-profiles/{creditorProfile}/edit:
    get:
      tags:
        - Manage Creditors
      summary: Edit creditor profile
      description: >-
        Return editable creditor profile form data and contacts. Active
        company-backed profiles return a conflict response because they are
        read-only.
      operationId: ecomailhubEditManageCreditorProfile
      parameters:
        - name: creditorProfile
          in: path
          required: true
          schema:
            type: integer
          description: Creditor profile ID from the manage creditors list.
      responses:
        '200':
          description: Editable creditor profile form data returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManageCreditorProfileEditResponse'
              example:
                data:
                  id: 22
                  row_type: creditor_profile
                  profile_status:
                    value: consumer_prospect
                    label: Consumer Prospect
                    short_label: CP
                  form:
                    company_name: Editable Capital
                    company_phone: '8186017451'
                    company_phone_label: (818) 601-7451
                    company_email: editable@example.test
                    company_address_1: 123 Funding Street
                    company_address_2: Suite 5
                    company_city: Los Angeles
                    company_state: CA
                    company_zip: '90001'
                    company_url: https://editable.example.test
                  contacts:
                    - id: 3
                      first_name: Nancy
                      last_name: Williams
                      email: nancy@example.test
                      phone: '8186011111'
                      phone_label: (818) 601-1111
                  max_contacts: 3
                  can_add_contact: true
                  can_edit_profile: true
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: Creditor profile is active-company backed and cannot be edited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
              example:
                message: Sorry, you cannot edit the profile of an active company.
      security:
        - bearerAuth: []
components:
  schemas:
    ManageCreditorProfileEditResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/EcomailhubCreditorProfileEdit'
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    EcomailhubCreditorProfileEdit:
      type: object
      required:
        - id
        - row_type
        - profile_status
        - form
        - contacts
        - max_contacts
        - can_add_contact
        - can_edit_profile
      properties:
        id:
          type: integer
          example: 22
        row_type:
          type: string
          enum:
            - creditor_profile
          example: creditor_profile
        profile_status:
          $ref: '#/components/schemas/EcomailhubCreditorProfileStatus'
        form:
          $ref: '#/components/schemas/EcomailhubCreditorProfileEditForm'
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/EcomailhubCreditorProfileContact'
        max_contacts:
          type: integer
          example: 3
        can_add_contact:
          type: boolean
          example: true
        can_edit_profile:
          type: boolean
          example: true
    EcomailhubCreditorProfileStatus:
      type: object
      required:
        - value
        - label
        - short_label
      properties:
        value:
          type: string
          enum:
            - active_member
            - pending_member
            - yn_prospect
            - consumer_prospect
          example: active_member
        label:
          type: string
          example: Active Member
        short_label:
          type: string
          example: AM
    EcomailhubCreditorProfileEditForm:
      type: object
      required:
        - company_name
        - company_phone
        - company_phone_label
        - company_email
        - company_address_1
        - company_address_2
        - company_city
        - company_state
        - company_zip
        - company_url
      properties:
        company_name:
          type:
            - string
            - 'null'
          example: Editable Capital
        company_phone:
          type:
            - string
            - 'null'
          example: '8186017451'
        company_phone_label:
          type:
            - string
            - 'null'
          example: (818) 601-7451
        company_email:
          type:
            - string
            - 'null'
          format: email
          example: editable@example.test
        company_address_1:
          type:
            - string
            - 'null'
          example: 123 Funding Street
        company_address_2:
          type:
            - string
            - 'null'
          example: Suite 5
        company_city:
          type:
            - string
            - 'null'
          example: Los Angeles
        company_state:
          type:
            - string
            - 'null'
          example: CA
        company_zip:
          type:
            - string
            - 'null'
          example: '90001'
        company_url:
          type:
            - string
            - 'null'
          example: https://editable.example.test
    EcomailhubCreditorProfileContact:
      type: object
      required:
        - id
        - first_name
        - last_name
        - email
        - phone
        - phone_label
      properties:
        id:
          type: integer
          example: 3
        first_name:
          type: string
          example: Nancy
        last_name:
          type: string
          example: Williams
        email:
          type: string
          format: email
          example: nancy@example.test
        phone:
          type: string
          example: '8186011111'
        phone_label:
          type:
            - string
            - 'null'
          example: (818) 601-1111
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
          example:
            message: Unauthenticated.
    NotFound:
      description: Requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
          example:
            message: Not Found.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum

````