POST: 유저 속성 생성 및 업데이트

POST /api/v1/user-profile

고객의 유저 속성을 생성 및 업데이트할 수 있는 API입니다.

유저 속성의 생성 및 업데이트 API 호출은 유저의 속성의 변경 시점에만 호출하는 것이 좋습니다. 연동 시에는 항상 요청 제한을 고려해야 합니다.

쿼리 파라미터

이름	필수값 여부	타입	설명
service_id	필수	String	서비스 ID

헤더

필드명	필수값 여부	타입	값	설명
Content-Type	필수	String	application/json	-
access_token	필수	String	your-api-token-key	API 인증 토큰

요청 본문

필드명	필수값 여부	타입	설명
identity	필수	Object	유저 식별자
user_properties	필수	Object	유저 속성, Datetime 타입의 경우 UTC 타임존 기준
request_datetime	필수	Datetime	요청 시각, ISODate 8601 Format, UTC 타임존 기준 2024-06-24T06:42:25.394Z

identity

유저 식별자 정보입니다. 아래 필드 중 적어도 하나의 값을 넣어주어야 합니다.

필드명	필수값 여부	타입	설명
external_id	선택	String	외부 ID
phone_no	선택	String	전화 번호
email	선택	String	이메일
kakao_user_id	선택	String	카카오 ID
line_user_id	선택	String	라인 ID

user_properties

유저 속성입니다. 필드명은 콘솔에서 사전 등록된 유저 속성의 속성명을, 값은 해당 속성의 값을 넣어주어야 합니다. 사전 등록된 유저 속성의 종류는 아래와 같습니다.

• 표준 유저 프로필 속성
• 커스텀 유저 프로필 속성
• 채널 수신 동의 속성

필드명	필수값 여부	타입	설명
${your-user-property-key}	선택	String, Long, Double, Boolean, Datetime, Array	사전 등록된 유저 속성 정보

요청 예시

curl -L \
  -X POST \
  -H 'access_token: ${your-import-api-token}' \
  -H 'Content-Type: application/json' \
  'https://openapi.dfinery.ai/api/v1/user-profile?service_id=${your-service-id}' \
  -d '{
  "identity": {
    "external_id": "dfn-user-123"
  },
  "user_properties": {
    "df_gender": "Female"
  },
  "request_datetime": "2024-05-14T06:05:46.363Z"
}
 '

응답 예시

정상 응답

Content-Type: application/json
access_token: text
{
  "status": true,
  "code": "20000",
  "message": "OK",
  "data": true
}

실패 응답

자세한 내용은 상세 응답 참고하시면 됩니다.