POST /api/v1/user-profile

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

쿼리 파라미터

헤더

요청 본문

identity

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

user_properties

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

요청 예시

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
}

실패 응답

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

Profile API를 통해 유저의 속성을 생성하거나 업데이트 할 수 있습니다. API 연동을 위해서는 먼저 기본 세팅을 완료하여야 합니다. API 연동을 위한 기본 세팅을 아직 하지 못했다면, 시작하기 전에 를 참고해 주시면 됩니다.

사용 사례

알림 수신 동의 정보 설정하기

유저 속성 생성 및 업데이트 API를 통해 온/오프라인 채널에 대한 유저의 수신 동의 정보 값을 설정할 수 있습니다.

오후 9시 부터 오전 8시 사이에는 별도의 수신 동의를 받아야 광고성 알림을 전송할 수 있습니다.

알림 수신 동의 정보에 대한 유저 프로필은 예외적으로 DFINERY에서 서비스 생성 시 이미 자동으로 등록되어 있어 DFINERY 콘솔에서 설정하지 않아도 설정이 가능합니다.

수신 동의 정보는 기본값을 통해 따로 설정하지 않아도 발송될 수 있습니다. 자세한 사항은 이용자 가이드의 를 참고하시면 됩니다.