---
updatedAt: 2026-08-04T14:08:40.000Z
agentTools:
  projectIndex: https://docs.mesh.complyadvantage.com/llms.txt
---

# Update an existing custom field

Update the display_name and/or description of an existing custom field for your account.

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "activity_CustomField": {
        "properties": {
          "data_type": {
            "$ref": "#/components/schemas/activity_CustomFieldDataTypeV3"
          },
          "description": {
            "type": "string"
          },
          "display_name": {
            "type": "string"
          },
          "identifier": {
            "format": "uuid",
            "type": "string"
          },
          "key": {
            "type": "string"
          }
        },
        "required": [
          "data_type",
          "description",
          "display_name",
          "identifier",
          "key"
        ],
        "type": "object"
      },
      "activity_CustomFieldDataTypeV3": {
        "description": "The type of data stored in a custom field.",
        "enum": [
          "TEXT",
          "DECIMAL"
        ],
        "type": "string"
      },
      "activity_ProblemDetailErrorResponse": {
        "additionalProperties": true,
        "properties": {
          "detail": {
            "nullable": true,
            "type": "string"
          },
          "identifier": {
            "format": "uuid",
            "type": "string"
          },
          "instance": {
            "format": "uri",
            "nullable": true,
            "type": "string"
          },
          "status": {
            "format": "int32",
            "nullable": true,
            "type": "integer"
          },
          "timestamp": {
            "format": "date-time",
            "type": "string"
          },
          "title": {
            "nullable": true,
            "type": "string"
          },
          "type": {
            "format": "uri",
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "identifier",
          "timestamp"
        ],
        "type": "object"
      },
      "activity_UpdateCustomFieldRequest": {
        "properties": {
          "description": {
            "maxLength": 1000,
            "minLength": 0,
            "nullable": true,
            "type": "string"
          },
          "display_name": {
            "maxLength": 50,
            "minLength": 0,
            "nullable": true,
            "type": "string"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "description": "HTTP Bearer Token Authentication",
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "title": "Mesh API",
    "version": "v2.0"
  },
  "openapi": "3.0.3",
  "paths": {
    "/v3/transactions/custom-fields/{custom_field_identifier}": {
      "patch": {
        "description": "Update the display_name and/or description of an existing custom field for your account.",
        "operationId": "activityStoreUpdateCustomField",
        "parameters": [
          {
            "description": "The identifier of the custom field to update.",
            "example": "12345678-9012-3456-7890-123456789012",
            "in": "path",
            "name": "custom_field_identifier",
            "required": true,
            "schema": {
              "description": "The identifier of the custom field to update.",
              "example": "12345678-9012-3456-7890-123456789012",
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/activity_UpdateCustomFieldRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/activity_CustomField"
                }
              }
            },
            "description": "Custom field updated successfully"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/activity_ProblemDetailErrorResponse"
                }
              }
            },
            "description": "Validation error"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/activity_ProblemDetailErrorResponse"
                }
              }
            },
            "description": "Custom field not found"
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/activity_ProblemDetailErrorResponse"
                }
              }
            },
            "description": "Internal Server Error"
          }
        },
        "summary": "Update an existing custom field",
        "tags": [
          "Transactions"
        ]
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "servers": [
    {
      "description": "ComplyAdvantage Mesh API",
      "url": "https://api.mesh.complyadvantage.com"
    }
  ],
  "tags": [
    {
      "name": "Transactions"
    }
  ]
}
```