> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Update a Segment > Use this endpoint to update the details of a Segment. ## OpenAPI ````yaml /en/openapi/v3-current/ledger.yaml patch /v1/organizations/{organization_id}/ledgers/{ledger_id}/segments/{segment_id} openapi: 3.1.0 info: title: Midaz Ledger API description: >- Complete API reference for Midaz Ledger services including organization management, ledger operations, assets, segments, portfolios, accounts, account types, transactions, operations, balances, operation routes, transaction routes, and metadata indexes. version: 3.7.0 servers: - url: https://ledger.sandbox.lerian.net security: [] tags: - name: Organizations API - name: Ledgers API - name: Assets API - name: Segments API - name: Portfolios API - name: Account Types API - name: Accounts API - name: Balances API - name: Transactions API - name: Operations API - name: Operation Routes API - name: Transaction Routes API - name: Metadata Indexes API paths: /v1/organizations/{organization_id}/ledgers/{ledger_id}/segments/{segment_id}: patch: tags: - Segments API summary: Update a Segment description: Use this endpoint to update the details of a Segment. parameters: - $ref: '#/components/parameters/OrganizationId' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/LedgerId' - $ref: '#/components/parameters/ContentType' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/SegmentId' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSegmentRequest' example: name: Business Accounts status: code: BLOCKED description: Segment temporarily blocked due to policy changes metadata: minMonthlyIncome: 12000 creditScoreThreshold: 760 tier: Platinum fxEnabled: true overdraftEligibility: false dailyTransferLimit: 60000 segmentationSource: internal_scoring_engine notes: Segment updated based on revised KYC criteria responses: '200': description: >- Indicates that the request was successful and the response contains the expected data. content: application/json: schema: $ref: '#/components/schemas/CreateSegmentResponse' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0047: $ref: '#/components/examples/Error0047' Error0050: $ref: '#/components/examples/Error0050' Error0051: $ref: '#/components/examples/Error0051' Error0053: $ref: '#/components/examples/Error0053' Error0065: $ref: '#/components/examples/Error0065' Error0067: $ref: '#/components/examples/Error0067' Error0094: $ref: '#/components/examples/Error0094' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0041: $ref: '#/components/examples/Error0041' Error0042: $ref: '#/components/examples/Error0042' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0043: $ref: '#/components/examples/Error0043' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0007: $ref: '#/components/examples/Error0007' Error0036: $ref: '#/components/examples/Error0036' '409': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0015: $ref: '#/components/examples/Error0015' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0046: $ref: '#/components/examples/Error0046' security: [] components: parameters: OrganizationId: name: organization_id in: path description: The unique identifier of the Organization associated with the Ledger. required: true example: 019c96a0-0a98-7287-9a31-786e0809c769 schema: type: string Authorization: name: Authorization in: header description: >- The authorization token. **This header is required if your environment has Access Manager enabled**. required: false schema: type: string LedgerId: name: ledger_id in: path description: The unique identifier of the associated Ledger. required: true example: 019c96a0-0ac0-7de9-9f53-9cf842a2ee5a schema: type: string ContentType: name: Content-Type in: header description: >- The type of media of the resource. Recommended value is `application/json`. required: false example: application/json schema: type: string XRequestId: name: X-Request-Id in: header description: A unique identifier used to trace and track each request. required: false example: 019c96a0-0a98-7287-9a31-786e0809c769 schema: type: string format: uuid SegmentId: name: segment_id in: path description: >- The unique identifier of the segment that you want to retrieve, delete or update. required: true example: 019c96a0-0b4e-7079-8be0-ab6bdccf975f schema: type: string format: uuid schemas: UpdateSegmentRequest: type: object properties: name: type: string description: The name of the Segment. maxLength: 256 status: $ref: '#/components/schemas/StatusOrganizationRequest' metadata: $ref: '#/components/schemas/Metadata' CreateSegmentResponse: type: object properties: id: type: string description: The unique identifier of the Segment. format: uuid organizationId: type: string format: uuid description: The unique identifier of the Organization. ledgerId: type: string description: The unique identifier of the Ledger. format: uuid name: type: string description: The name of the Segment. maxLength: 256 status: c4dab307-315a-43de-9234-9064b178981e metadata: $ref: '#/components/schemas/Metadata' createdAt: type: string format: date-time description: Timestamp of creation (UTC). updatedAt: type: string format: date-time description: Timestamp of last update (UTC). deletedAt: type: - string - 'null' format: date-time description: Timestamp of soft deletion, if applicable (UTC). ErrorFormat: type: object description: The response message error. required: - code - title - message properties: code: type: string description: A unique, stable identifier for the error. title: type: string description: A brief summary of the issue. message: type: string description: Detailed guidance for resolving the error. fields: type: object additionalProperties: true description: Additional information about the fields that caused the error. StatusOrganizationRequest: type: object description: >- An object containing information about the status. **Important**: If not provided, the default status will be 'ACTIVE'. properties: code: type: string maxLength: 100 description: The name of the status. description: type: - string - 'null' maxLength: 256 description: The description of the status. StatusOrganization: type: object description: An object containing information about the status. properties: code: type: string maxLength: 100 description: The name of the status. description: type: - string - 'null' maxLength: 256 description: The description of the status. Metadata: type: object additionalProperties: type: string description: >- An object containing key-value pairs to add as metadata, where the field `name` is the key and the field `value` is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'. examples: Error0047: summary: Bad Request value: code: '0047' title: Bad Request message: >- The server could not understand the request due to malformed syntax. Please check the listed fields and try again. Error0050: value: code: '0050' title: Invalid Metadata message: >- One or more metadata entries are invalid. Please ensure metadata keys and values follow the allowed format. summary: Invalid Metadata Error0051: value: code: '0051' title: Invalid Metadata Key message: >- A metadata key contains unsupported characters or exceeds length limits. Please correct the key and try again. summary: Invalid Metadata Key Error0053: value: code: '0053' title: Unexpected Fields in the Request message: >- The request body contains more fields than expected. Please send only the allowed fields as per the documentation. The unexpected fields are listed in the fields object. fields: '{{field}}': '{{value}}' summary: Unexpected Fields in the Request Error0065: value: code: '0065' title: Invalid Path Parameter message: >- The provided path parameter {{parameter_name}} is not in the expected format. Please ensure the parameter adheres to the required format and try again. summary: Invalid Path Parameter Error0067: value: code: '0067' title: Invalid Metadata Nesting message: >- The metadata object cannot contain nested values. Please ensure that the value {{value}} is not nested and try again. summary: Invalid Metadata Nesting Error0094: value: code: '0094' title: Invalid Request Body message: >- The request body is invalid or could not be parsed. Please check JSON structure and field types. summary: Invalid Request Body Error0041: summary: Token Missing value: code: '0041' title: Token Missing message: >- A valid token must be provided in the request header. Please include a token and try again. Error0042: summary: Invalid Token value: code: '0042' title: Invalid Token message: >- The provided token is expired, invalid or malformed. Please provide a valid token and try again. Error0043: summary: Insufficient Privileges value: code: '0043' title: Insufficient Privileges message: >- You do not have the necessary permissions to perform this action. Please contact your administrator if you believe this is an error. Error0007: value: code: '0007' title: Entity Not Found message: >- No entity was found for the given ID. Please make sure to use the correct ID for the entity you are trying to manage. summary: Entity Not Found Error0036: summary: Segment ID Not Found value: code: '0036' title: Segment ID Not Found message: >- The provided segment ID does not exist in our records. Please verify the segment ID and try again. Error0015: summary: Duplicate Segment Name Error value: code: '0015' title: Duplicate Segment Name Error message: >- A segment with the name {{name}} already exists for this ledger ID {{ledgerId}}. Please try again with a different ledger or name. Error0046: summary: Internal Server Error value: code: '0046' title: Internal Server Error message: >- The server encountered an unexpected error. Please try again later or contact support. ````