Skip to main content
Identities

Update an identity

Update a Forward identity.

POST /api/v1/forward/identities/{identity_id} Updates mutable Identity fields. Omitted fields are unchanged. metadata is merged; a metadata value of an empty string deletes that key.

Headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT or SAT>
Content-TypeYesapplication/json
Idempotency-KeyNoOptional idempotency key for unsafe requests.

Path parameters

ParameterTypeRequiredDescription
identity_idstringYesForward Identity ID.

Body parameters

ParameterTypeRequiredDescription
external_idstringNoReplaces the existing end-user ID.
namestringNoReplaces the display name.
enabledbooleanNoUpdates whether the Identity can be used.
auto_memory_storeboolean|nullNoWhether to automatically create a default Memory Store on demand when creating a Session. Omitted or null preserves the current value.
metadataobjectNoMerge updates custom metadata. Empty string values delete keys.

Example request

curl -s -X POST 'https://api.qoder.com.cn/api/v1/forward/identities/idn_019eabc123' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Example User",
    "enabled": false,
    "auto_memory_store": false,
    "metadata": {
      "channel": "app"
    }
  }'

Example response

HTTP 200 OK 
{
  "id": "idn_019eabc123",
  "external_id": "user_456",
  "name": "Example User",
  "enabled": false,
  "auto_memory_store": false,
  "metadata": {
    "channel": "app"
  },
  "created_at": "2026-06-18T10:00:00Z",
  "updated_at": "2026-06-18T10:30:00Z"
}

Response fields

Returns the updated Identity object.

Errors

HTTPTypeCodeTrigger
400invalid_request_error-The request body is invalid.
401authentication_error-The PAT or SAT is invalid or expired.
404not_found_error-The Identity does not exist.
409conflict_error-The Identity conflicts with an existing record.

Notes

  • auto_memory_store=false only stops future automatic creation of default Memory Stores. Existing default and explicit mounts keep their bindings and permissions and remain available to new Sessions; existing Sessions are unaffected.
  • Setting it back to true allows future on-demand creation, but does not clear the automatic-creation disabled state for the current (identity, template) caused by detaching the default Store.
  • Updating enabled has the same execution and recovery semantics as disabling or enabling an Identity. Already accepted executions finish naturally.
  • Historical sessions and audit records are not modified.

Get an identity

Delete an identity