Skip to main content
PATCH
고객 속성 정의 수정

Authorizations

Authorization
string
header
required

조직 API 키를 Authorization: Bearer <token> 형식으로 보냅니다.

Path Parameters

definition_id
string<uuid>
required

Body

application/json

수정할 고객 속성 정의 필드입니다. type은 수정할 수 없습니다. is_active를 false로 설정하면 자동 추출에서 제외하고, true로 설정하면 다시 활성화합니다.

수정할 수 있는 필드만 노출합니다. type은 수정할 수 없습니다.

name
string

속성 이름입니다. 생략하면 현재 값을 유지합니다.

description
string | null

속성 설명입니다. 생략하면 현재 값을 유지합니다.

enum_options
string[] | null

enum 형식에 허용되는 문자열 값입니다. enum이 아닌 형식에는 지정할 수 없습니다.

conflict_mode
enum<string>

자동 추출 값의 충돌 처리 방식입니다. 생략하면 현재 값을 유지합니다.

Available options:
overwrite,
fill_if_empty
is_active
boolean

속성 정의의 활성 여부입니다. false이면 자동 추출에서 제외합니다. 생략하면 현재 값을 유지합니다.

Response

성공 응답

id
string
required

고객 속성 정의 UUID입니다.

name
string
required

조직 안에서 고유한 속성 이름입니다.

type
enum<string>
required

속성 값 유형입니다.

Available options:
string,
number,
boolean,
enum,
date
description
string | null
required

속성 설명입니다.

conflict_mode
enum<string>
required

자동 추출 값의 갱신 방식입니다. 기존 값을 항상 덮어쓰거나, 기존 값이 비어 있을 때만 채울 수 있습니다.

Available options:
overwrite,
fill_if_empty
is_active
boolean
required

정의의 활성 여부입니다.

created_at
integer
required

리소스 생성 시각입니다. 밀리초 단위 unix timestamp입니다.

updated_at
integer
required

리소스 수정 시각입니다. 밀리초 단위 unix timestamp입니다.

enum_options
string[] | null

enum 유형에서 허용하는 문자열 값 목록입니다. 다른 유형이면 null입니다.