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

# Update an RMA

> Changes an RMA's date, note or returns.

Send `rma_date`, `note` or `returns` under `return_merchandise_authorisation`. The RMA comes back under the same key. The shape of a `returns` entry is not documented.

> [!NOTE]
>
> The SDK samples get their client from credentials your app registers once when it starts, as shown in [Authentication](https://exsited.mintlify.site/authentication.md#set-up-a-client). To try the call here, click **Try it**, set `host` to your Exsited API host name and paste an access token from [Get an access token](https://exsited.mintlify.site/api-reference/authentication/get-an-access-token.md). To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its `-d` payload.


## OpenAPI

````yaml PATCH /return_merchandise_authorisations/{rma_id}
openapi: 3.1.0
info:
  title: Exsited API
  version: v4
servers:
  - url: https://{host}/api/v4
    variables:
      host:
        default: your-api-host.example.com
        description: Your Exsited API host name, without https://.
security:
  - bearerAuth: []
tags:
  - name: Authentication
  - name: Accounts
  - name: Account emails
  - name: Account groups
  - name: Communications
  - name: Communication profiles
  - name: Orders
  - name: Quote orders
  - name: Express
  - name: Usages
  - name: Sales reps
  - name: Gift certificates
  - name: Invoices
  - name: Pro-forma invoices
  - name: Payments
  - name: Refunds
  - name: Credit notes
  - name: Credit note applications
  - name: Reconciliations
  - name: Items
  - name: Inventory adjustments
  - name: Units of measurement
  - name: Zones
  - name: Shipping packages
  - name: Shipping rules
  - name: Fulfillment profiles
  - name: Fulfillment terms
  - name: Item fulfillments
  - name: Item receipts
  - name: Bookings
  - name: Rental assets
  - name: Return merchandise authorisations
  - name: Purchase orders
  - name: Purchase invoices
  - name: Purchase payments
  - name: Purchase refunds
  - name: Purchase credit notes
  - name: Purchase credit note applications
  - name: Purchase express
  - name: Return vendor authorizations
  - name: ABA files
  - name: Receive terms
  - name: Labours
  - name: Tasks
  - name: Timesheets
  - name: Milestones
  - name: Employees
  - name: Departments
  - name: Designations
  - name: Teams
  - name: Time periods
  - name: Workflows
  - name: Workflow settings
  - name: Events
  - name: Custom events
  - name: System events
  - name: Approvals
  - name: Approval profiles
  - name: Approval user groups
  - name: Alerts
  - name: Alert responsibility settings
  - name: Alert responsibilities
  - name: Action scripts
  - name: Note groups
  - name: Note attachments
  - name: Instance settings
  - name: Accounting codes
  - name: Additional codes
  - name: Billing periods
  - name: Charging periods
  - name: Pricing periods
  - name: Invoice terms
  - name: Days of the month
  - name: Countries
  - name: Salutations
  - name: Document templates
  - name: Email templates
  - name: Roles
  - name: Operators
  - name: Operator groups
  - name: User settings
  - name: Custom attributes
  - name: Custom components
  - name: Custom features
  - name: Custom fields
  - name: Custom forms
  - name: Attribute attachments
  - name: Portal
  - name: Integration connections
  - name: External databases
  - name: Reports
  - name: Applications
  - name: Organisation
  - name: Child organisations
  - name: Webhooks
paths:
  /return_merchandise_authorisations/{rma_id}:
    patch:
      tags:
        - Return merchandise authorisations
      summary: Update an RMA
      description: >-
        Send `rma_date`, `note` or `returns` under
        `return_merchandise_authorisation`. The RMA comes back under the same
        key. The shape of a `returns` entry is not documented.
      operationId: >-
        return_merchandise_authorisations_update_return_merchandise_authorisation
      parameters:
        - name: rma_id
          in: path
          required: true
          description: The RMA's `id`, which starts with `rma_`. Its `code` is refused.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - return_merchandise_authorisation
              properties:
                return_merchandise_authorisation:
                  type: object
                  properties:
                    rma_date:
                      type: string
                      format: date
                    note:
                      type: string
                    returns:
                      type: array
                      items:
                        type: object
            example:
              return_merchandise_authorisation:
                rma_date: '2026-10-01'
                note: Customer returned one unit
      responses:
        '200':
          description: The RMA, under `return_merchandise_authorisation`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnMerchandiseAuthorisationResponse'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl -X PATCH
            "$EXSITED_BASE_URL/api/v4/return_merchandise_authorisations/RMA_ID"
            \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "return_merchandise_authorisation": {
                  "rma_date": "2026-10-01",
                  "note": "Customer returned one unit"
                }
              }'
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = (
                client.return_merchandise_authorisations.update_return_merchandise_authorisation(
                    "RMA_ID",
                    {
                        "return_merchandise_authorisation": {
                            "rma_date": "2026-10-01",
                            "note": "Customer returned one unit",
                        }
                    },
                )
            )
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: >
            import {buildClient} from 'exsited';


            const client = await buildClient();


            const response = await
            client.returnMerchandiseAuthorisations.updateReturnMerchandiseAuthorisation('RMA_ID',
            {
                return_merchandise_authorisation: {rma_date: '2026-10-01', note: 'Customer returned one unit'},
            });

            console.log(response.data);
        - lang: php
          label: PHP
          source: >
            use Exsited\Client\ClientRegistry;


            $client = ClientRegistry::buildClient();


            $response =
            $client->returnMerchandiseAuthorisations->updateReturnMerchandiseAuthorisation(
                'RMA_ID',
                [
                    'return_merchandise_authorisation' => [
                        'rma_date' => '2026-10-01',
                        'note' => 'Customer returned one unit',
                    ],
                ],
            );

            print_r($response->data);
        - lang: java
          label: Java
          source: >
            import com.exsited.client.ApiResponse;

            import com.exsited.client.ClientRegistry;

            import com.exsited.client.ExsitedClient;

            import
            com.exsited.resources.return_merchandise_authorisations.return_merchandise_authorisations_dto.ReturnMerchandiseAuthorisationsDto.ReturnMerchandiseAuthorisationRead;

            import java.util.Map;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<ReturnMerchandiseAuthorisationRead> response =
            client.returnMerchandiseAuthorisations().updateReturnMerchandiseAuthorisation(
                    "RMA_ID",
                    Map.of(
                            "return_merchandise_authorisation", Map.of(
                                    "rma_date", "2026-10-01",
                                    "note", "Customer returned one unit")));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await
            client.ReturnMerchandiseAuthorisations.UpdateReturnMerchandiseAuthorisationAsync(
                "RMA_ID",
                new Dictionary<string, object?>
                {
                    ["return_merchandise_authorisation"] = new Dictionary<string, object?>
                    {
                        ["rma_date"] = "2026-10-01",
                        ["note"] = "Customer returned one unit",
                    },
                });

            Console.WriteLine(response.Json);
        - lang: dart
          label: Dart
          source: |
            import 'package:exsited/exsited.dart';

            final client = buildClient();

            final response = await client.returnMerchandiseAuthorisations
                .updateReturnMerchandiseAuthorisation('RMA_ID', {
                  'return_merchandise_authorisation': {
                    'rma_date': '2026-10-01',
                    'note': 'Customer returned one unit',
                  },
                });
            print(response.map);
        - lang: go
          label: Go
          source: "import (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\texsited \"github.com/exsited/exsited-sdk-go/v4\"\n)\n\nclient, err := exsited.BuildClient(nil)\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer client.Close()\n\nresponse, err := client.ReturnMerchandiseAuthorisations().UpdateReturnMerchandiseAuthorisation(context.Background(), \"RMA_ID\", map[string]any{\n\t\"return_merchandise_authorisation\": map[string]any{\n\t\t\"rma_date\": \"2026-10-01\",\n\t\t\"note\":     \"Customer returned one unit\",\n\t},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    ReturnMerchandiseAuthorisationResponse:
      type: object
      required:
        - return_merchandise_authorisation
      properties:
        return_merchandise_authorisation:
          $ref: '#/components/schemas/ReturnMerchandiseAuthorisationRead'
    ReturnMerchandiseAuthorisationRead:
      type: object
      properties:
        account:
          $ref: '#/components/schemas/ReturnMerchandiseAuthorisationReadAccount'
        code:
          type: string
        created_by:
          $ref: '#/components/schemas/ReturnMerchandiseAuthorisationReadCreatedBy'
        created_on:
          type: string
        href:
          type: string
        id:
          type: string
        item_count:
          type: integer
        last_updated_by:
          type: 'null'
          description: Returned as `null`.
        last_updated_on:
          type: 'null'
          description: Returned as `null`.
        lines:
          type: array
        note:
          type: string
        object:
          type: string
        receive_rmas:
          type: array
          items:
            $ref: '#/components/schemas/ReturnMerchandiseAuthorisationReadReceiveRma'
        return_status:
          type: string
        rma_date:
          type: string
        sale_invoice:
          $ref: '#/components/schemas/ReturnMerchandiseAuthorisationReadSaleInvoice'
        sale_order:
          type: 'null'
          description: Returned as `null`.
        status:
          type: string
        version:
          type: integer
        warehouse:
          type: 'null'
          description: Returned as `null`.
    ReturnMerchandiseAuthorisationReadAccount:
      type: object
      properties:
        code:
          type: string
        href:
          type: string
        id:
          type: string
        name:
          type: string
        object:
          type: string
    ReturnMerchandiseAuthorisationReadCreatedBy:
      type: object
      properties:
        name:
          type: string
        object:
          type: string
    ReturnMerchandiseAuthorisationReadReceiveRma:
      type: object
      properties:
        code:
          type: string
        created_by:
          $ref: >-
            #/components/schemas/ReturnMerchandiseAuthorisationReadReceiveRmaCreatedBy
        created_on:
          type: string
        href:
          type: string
        id:
          type: string
        last_updated_by:
          type: 'null'
          description: Returned as `null`.
        last_updated_on:
          type: 'null'
          description: Returned as `null`.
        object:
          type: string
        quantity_received:
          type: number
        status:
          type: string
    ReturnMerchandiseAuthorisationReadSaleInvoice:
      type: object
      properties:
        code:
          type: string
        href:
          type: string
        id:
          type: string
        object:
          type: string
    ReturnMerchandiseAuthorisationReadReceiveRmaCreatedBy:
      type: object
      properties:
        name:
          type: string
        object:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An access token from `POST /api/v4/oauth2/token`. The SDKs get and renew
        it for you.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.