API ReferenceUser Profiles

Update user profile

This API enables you to update an existing user profile. It updates the entire user profile including distinct_id (if specified).

Note: If there were existing values in the profile, they will be completely replaced (if those keys are passed) or ignored (if those keys are not passed).

Path parameters

WSIDstringRequired

Enter your workspace ID. You can obtain this value from the API Keys page within your Fyno account.

versionenumRequired

Specify the version for which you would like to manage the user profile.

Allowed values:
distinct_idstringRequired

Enter the distinct ID that you currently use to identify the user.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
channelobjectOptional

(Optional) If you do not wish to change any channel values, remove this key from the payload. Note: If you change any value in the channel key, the entire channel data is replaced.

distinct_idstringOptional

(Optional) Enter the new distinct ID that you wish to use to identify the user. If you do not wish to change this value, remove this key from the payload.

namestringOptional

(Optional) Enter the new full name of the user. If you do not wish to change this value, remove this key from the payload.

statusenumOptional

(Optional) Enter 1 to change the user’s status to active so that the user can receive notifications. Enter 0 to change the user’s status to inactive so that the user does not receive any notification. If you do not wish to change this value, remove this key from the payload. If null, the default value is 1.

Allowed values:
timezoneenumOptional

(Optional) Enter the new timezone of the user. For a list of possible values, please click here.

Response

This endpoint returns an object.
_messagestring
statusstring

Errors