POST: Create and update user properties

POST /api/v1/user-profile

An API that allows you to create and update customer user properties.

It is recommended that API calls for creating and updating user properties be made only when the user's properties change. Request limits should always be taken into account when linking.

Query parameters

Name	Whether required	Type	Explanation
service_id	Essential	String	Service ID

Header

Field name	Whether required	Type	Value	Explanation
Content-Type	Essential	String	application/json	-
access_token	Essential	String	your-api-token-key	API Authentication Token

Request body

Field name	Whether required	Type	Explanation
identity	Essential	Object	User identifier
user_properties	Essential	Object	User properties
request_datetime	Essential	Datetime	Request Time, ISODate 8601 Format, 2024-06-24T06:42:25.394Z

Identity

User identifier information. You must enter a value in at least one of the fields below.

Field name	Whether required	Type	Explanation
external_id	Select	String	External ID
phone_no	Select	String	Phone number
email	Select	String	Email
kakao_user_id	Select	String	Kakao ID
line_user_id	Select	String	Line ID

User_properties

This is a user property. The field name should be the name of a user property pre-registered in the console, and the value should be the value of that property.

Field name	Whether required	Type	Explanation
${your-user-property-key}	Select	String, Long, Double, Boolean, Datetime, Array	Pre-registered user attribute information

Example request

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"
}
 '

Example response

Normal response

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

Failure response

Please refer to the detailed response for more details.