> ## 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 a fulfillment term

> Changes a fulfillment term, or turns it on or off, and returns it.

Send the changes under `fulfillment_term`. Set `status` to `active` or `inactive` to turn the term on or off.

> [!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 /settings/fulfillment_terms/{fulfillment_term_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:
  /settings/fulfillment_terms/{fulfillment_term_id}:
    patch:
      tags:
        - Fulfillment terms
      summary: Update a fulfillment term
      description: >-
        Send the changes under `fulfillment_term`. Set `status` to `active` or
        `inactive` to turn the term on or off.
      operationId: fulfillment_terms_update_settings_fulfillment_term
      parameters:
        - name: fulfillment_term_id
          in: path
          required: true
          description: The fulfillment term's `id`, from the listing.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                fulfillment_term:
                  type: object
                  properties:
                    name:
                      type: string
                    display_name:
                      type: string
                    description:
                      type: string
                    period:
                      type: string
                      description: Send in upper case, such as `MONTHLY`.
                    duration:
                      type: integer
                      description: How many periods the term lasts.
                    status:
                      type: string
                      description: '`active` or `inactive`.'
              required:
                - fulfillment_term
            example:
              fulfillment_term:
                display_name: One month
                description: Fulfill within a month
      responses:
        '200':
          description: The updated fulfillment term, under `fulfillment_term`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FulfillmentTermResponse'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl -X PATCH
            "$EXSITED_BASE_URL/api/v4/settings/fulfillment_terms/ft_6e7f8091a2b3c4d5e6f708192a3b4c5d"
            \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "fulfillment_term": {
                  "display_name": "One month",
                  "description": "Fulfill within a month"
                }
              }'
        - lang: python
          label: Python
          source: >
            from exsited import build_client


            client = build_client()


            response =
            client.fulfillment_terms.update_settings_fulfillment_term(
                "ft_6e7f8091a2b3c4d5e6f708192a3b4c5d",
                {
                    "fulfillment_term": {
                        "display_name": "One month",
                        "description": "Fulfill within a month",
                    }
                },
            )

            print(response.data)
        - lang: javascript
          label: JavaScript
          source: >
            import {buildClient} from 'exsited';


            const client = await buildClient();


            const response = await
            client.fulfillmentTerms.updateSettingsFulfillmentTerm('ft_6e7f8091a2b3c4d5e6f708192a3b4c5d',
            {
                fulfillment_term: {display_name: 'One month', description: 'Fulfill within a month'},
            });

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


            $client = ClientRegistry::buildClient();


            $response =
            $client->fulfillmentTerms->updateSettingsFulfillmentTerm(
                'ft_6e7f8091a2b3c4d5e6f708192a3b4c5d',
                [
                    'fulfillment_term' => [
                        'display_name' => 'One month',
                        'description' => 'Fulfill within a month',
                    ],
                ],
            );

            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.fulfillment_terms.fulfillment_terms_dto.FulfillmentTermsDto.SettingsFulfillmentTerm;

            import java.util.Map;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<SettingsFulfillmentTerm> response =
            client.fulfillmentTerms().updateSettingsFulfillmentTerm(
                    "ft_6e7f8091a2b3c4d5e6f708192a3b4c5d",
                    Map.of(
                            "fulfillment_term", Map.of(
                                    "display_name", "One month",
                                    "description", "Fulfill within a month")));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await
            client.FulfillmentTerms.UpdateSettingsFulfillmentTermAsync(
                "ft_6e7f8091a2b3c4d5e6f708192a3b4c5d",
                new Dictionary<string, object?>
                {
                    ["fulfillment_term"] = new Dictionary<string, object?>
                    {
                        ["display_name"] = "One month",
                        ["description"] = "Fulfill within a month",
                    },
                });

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


            final client = buildClient();


            final response = await
            client.fulfillmentTerms.updateSettingsFulfillmentTerm(
              'ft_6e7f8091a2b3c4d5e6f708192a3b4c5d',
              {
                'fulfillment_term': {
                  'display_name': 'One month',
                  'description': 'Fulfill within a month',
                },
              },
            );

            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.FulfillmentTerms().UpdateSettingsFulfillmentTerm(context.Background(), \"ft_6e7f8091a2b3c4d5e6f708192a3b4c5d\", map[string]any{\n\t\"fulfillment_term\": map[string]any{\n\t\t\"display_name\": \"One month\",\n\t\t\"description\":  \"Fulfill within a month\",\n\t},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    FulfillmentTermResponse:
      type: object
      properties:
        fulfillment_term:
          $ref: '#/components/schemas/FulfillmentTerm'
    FulfillmentTerm:
      type: object
      properties:
        created_by: {}
        created_on:
          type: string
        description:
          type: string
        display_name:
          type: string
        duration:
          type: integer
          description: How many periods the term lasts.
        href:
          type: string
        id:
          type: string
        last_updated_by: {}
        last_updated_on:
          type: string
        name:
          type: string
        object:
          type: string
        period:
          type: string
          description: The period in lower case, such as `monthly`.
        status:
          type: string
          description: '`active` or `inactive`.'
  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.