# citations.sources.insert

> Register a new citation source in the document store.



- Member path: `doc.citations.sources.insert(…)`
- Mutates document: yes
- Idempotency: `non-idempotent`
- Supports tracked mode: no
- Supports dry run: yes

## Expected result

Returns a CitationSourceMutationResult indicating success with the source address or a failure.

## Input schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$defs": {},
  "type": "object",
  "properties": {
    "type": {
      "enum": [
        "book",
        "journalArticle",
        "conferenceProceedings",
        "report",
        "website",
        "patent",
        "case",
        "statute",
        "thesis",
        "film",
        "interview",
        "misc"
      ]
    },
    "fields": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string"
        },
        "authors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "first": {
                "type": "string"
              },
              "middle": {
                "type": "string"
              },
              "last": {
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": [
              "last"
            ]
          }
        },
        "year": {
          "type": "string"
        },
        "publisher": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "journalName": {
          "type": "string"
        },
        "volume": {
          "type": "string"
        },
        "issue": {
          "type": "string"
        },
        "pages": {
          "type": "string"
        },
        "url": {
          "type": "string"
        },
        "doi": {
          "type": "string"
        },
        "edition": {
          "type": "string"
        },
        "editor": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "first": {
                "type": "string"
              },
              "middle": {
                "type": "string"
              },
              "last": {
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": [
              "last"
            ]
          }
        },
        "translator": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "first": {
                "type": "string"
              },
              "middle": {
                "type": "string"
              },
              "last": {
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": [
              "last"
            ]
          }
        },
        "medium": {
          "type": "string"
        },
        "shortTitle": {
          "type": "string"
        },
        "standardNumber": {
          "type": "string"
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false,
  "required": [
    "type",
    "fields"
  ]
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$defs": {},
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "success": {
          "const": true
        },
        "source": {
          "type": "object",
          "properties": {
            "kind": {
              "const": "entity"
            },
            "entityType": {
              "const": "citationSource"
            },
            "sourceId": {
              "type": "string"
            }
          },
          "additionalProperties": false,
          "required": [
            "kind",
            "entityType",
            "sourceId"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "success",
        "source"
      ]
    },
    {
      "type": "object",
      "properties": {
        "success": {
          "const": false
        },
        "failure": {
          "type": "object",
          "properties": {
            "code": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "details": {}
          },
          "additionalProperties": false,
          "required": [
            "code",
            "message"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "success",
        "failure"
      ]
    }
  ]
}
```

## Pre-apply throws

- `TARGET_NOT_FOUND`
- `INVALID_TARGET`
- `INVALID_INPUT`
- `CAPABILITY_UNAVAILABLE`

## Non-applied receipt codes

- None