API ReferenceUser Profiles

Create user profile

This API enables you to create a user profile within Fyno, which you can then use to send out notifications.

Before creating your first user profile, you should obtain the following values needed for authentication:
- API Key
- Workspace ID

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:

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
distinct_idstringRequired
Enter the distinct ID that you use to identify the user.
channelobjectOptional
namestringOptional

(Optional) Enter the full name of the user.

statusenumOptional

(Optional) Enter 1 to specify that the user is active and should receive notifications. Enter 0 to specify that the user in inactive and should not receive any notifications. If null, the default value is 1.

Allowed values:
timezoneenumOptional

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

Response

This endpoint returns an object.
_messagestring
statusstring

Errors