API

문서 수정

작성일 2026.03.24 | 수정일 2026.03.25

PATCH/crm-core/v1/documents/:documentId

Parameters

documentId*— 문서 고유 아이디

기존 문서의 정보를 수정합니다. MEMBER 이상 권한이 필요합니다.

chat

FINALIZED 상태의 문서는 content, htmlContent, name, templateId, recordId, linkedRecordIds 필드를 수정할 수 없습니다. 상태 변경만 가능합니다. (FINALIZED → ARCHIVED)

Body Params

Name	Type	Required	Description
name	string		문서 이름
content	Object		문서 내용
status	string		문서 상태 (DRAFT, FINALIZED, ARCHIVED)
attachments	Array<Object>		첨부파일 목록
fileId	string	*	파일 고유 아이디
fileName	string	*	파일 이름
fileSize	number	*	파일 크기 (바이트)
mimeType	string	*	MIME 타입
url	string	*	파일 URL

Response

Name	Type	Required	Description
documentId	string	*	문서 고유 아이디
accountId	string	*	계정 고유 아이디
documentTypeId	string		문서 유형 ID
entityId	string		개체 ID
recordId	string		레코드 ID
templateId	string		템플릿 ID
linkedRecordIds	Array<String>		연결된 레코드 ID 목록
issueMethod	string	*	발행 방식
name	string	*	문서 이름
content	Object		문서 내용
htmlContent	string		HTML 변환 내용
dataSnapshot	Object		생성 시점의 변수 데이터 스냅샷
attachments	Array<Object>		첨부파일 목록
fileId	string	*	파일 고유 아이디
fileName	string	*	파일 이름
fileSize	number	*	파일 크기 (바이트)
mimeType	string	*	MIME 타입
url	string	*	파일 URL (서명된 URL)
uploadedAt	date	*	업로드 일시
status	string	*	문서 상태 (DRAFT, FINALIZED, ARCHIVED)
issuedAt	date		발행 일시
ownerId	string		문서 소유자 멤버 ID
issuedBy	string		발행자 ID
dateCreated	date	*	최초 생성 날짜
dateUpdated	date	*	최근 수정 날짜

Structure

Request Structure

{
  "name": "샘플",
  "content": {
    "key": "value"
  },
  "status": "ACTIVE",
  "attachments": [
    {
      "fileId": "FILE20260324090000ABCDEFGHIJKLMN",
      "fileName": "document.pdf",
      "fileSize": 20,
      "mimeType": "application/pdf",
      "url": "https://storage.solapi.com/files/sample.pdf"
    }
  ]
}

Response Structure

{
  "documentId": "DOC20260324090000ABCDEFGHIJKLMNO",
  "accountId": "24010100001234",
  "documentTypeId": "DTYPE20260324090000ABCDEFGHIJKLM",
  "entityId": "ENT20260324090000ABCDEFGHIJKLMNO",
  "recordId": "REC20260324090000ABCDEFGHIJKLMNO",
  "templateId": "DTPL20260324090000ABCDEFGHIJKLM",
  "linkedRecordIds": [
    "샘플값"
  ],
  "issueMethod": "샘플값",
  "name": "샘플",
  "content": {
    "key": "value"
  },
  "htmlContent": "샘플값",
  "dataSnapshot": {
    "key": "value"
  },
  "attachments": [],
  "ownerId": "MEM20260324090000ABCDEFGHIJKLMNO",
  "status": "ACTIVE",
  "issuedAt": "2026-03-24T09:00:00.000Z",
  "issuedBy": "샘플값",
  "dateCreated": "2026-03-24T09:00:00.000Z",
  "dateUpdated": "2026-03-24T09:00:00.000Z"
}