---
updatedAt: 2026-07-02T13:23:40.000Z
agentTools:
  projectIndex: https://docs.mesh.complyadvantage.com/llms.txt
---

# Add or update a risk word

Adds a risk word to a custom list of type `RISK_WORD`, or updates it if a risk word with the same identifier already exists.


You need "Access to custom lists for customer screening" enabled and the "Create, update, and delete custom lists and their entities, and download entities" permission to use this endpoint.

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "customlist_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"
      },
      "customlist_RiskWordAddDTO": {
        "properties": {
          "identifier": {
            "type": "string"
          },
          "word": {
            "maxLength": 256,
            "minLength": 0,
            "type": "string"
          }
        },
        "required": [
          "identifier",
          "word"
        ],
        "type": "object"
      },
      "customlist_RiskWordDTO": {
        "properties": {
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "format": "uuid",
            "type": "string"
          },
          "identifier": {
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          },
          "updated_by": {
            "format": "uuid",
            "nullable": true,
            "type": "string"
          },
          "word": {
            "type": "string"
          }
        },
        "required": [
          "created_at",
          "created_by",
          "identifier",
          "updated_at",
          "word"
        ],
        "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": {
    "/v2/custom-lists/{custom_list_id}/risk-word": {
      "put": {
        "description": "Adds a risk word to a custom list of type `RISK_WORD`, or updates it if a risk word with the same identifier already exists.\n\n\nYou need \"Access to custom lists for customer screening\" enabled and the \"Create, update, and delete custom lists and their entities, and download entities\" permission to use this endpoint.",
        "operationId": "customListAPIAddOrUpdateRiskWordInList",
        "parameters": [
          {
            "description": "The identifier of the custom list containing the risk word to be added/updated.",
            "example": "00000000-0000-0000-0000-000000000000",
            "in": "path",
            "name": "custom_list_id",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/customlist_RiskWordAddDTO"
              }
            }
          },
          "required": true
        },
        "responses": {
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/customlist_RiskWordDTO"
                }
              }
            },
            "description": "The risk word has been registered and will be searchable as soon as possible"
          },
          "400": {
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/customlist_ProblemDetailErrorResponse"
                }
              }
            },
            "description": "The custom list id is expected to be a UUID, or the custom list is not of type RISK_WORD"
          },
          "403": {
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/customlist_ProblemDetailErrorResponse"
                }
              }
            },
            "description": "The custom list has exceeded the number of entities that can be added (1,000,000)"
          }
        },
        "summary": "Add or update a risk word",
        "tags": [
          "Custom Lists"
        ]
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "servers": [
    {
      "description": "ComplyAdvantage Mesh API",
      "url": "https://api.mesh.complyadvantage.com"
    }
  ],
  "tags": [
    {
      "name": "Custom Lists"
    }
  ]
}
```