POST
/
v3
/
user
curl --request POST \
  --url https://safe.dfda.earth/api/v3/user \
  --header 'Content-Type: application/json' \
  --header 'X-CLIENT-ID: <api-key>' \
  --header 'X-CLIENT-SECRET: <api-key>' \
  --data '{
  "clientUserId": "<string>",
  "combineNotifications": true,
  "description": "<string>",
  "displayName": "<string>",
  "earliestReminderTime": "<string>",
  "email": "<string>",
  "firstName": "<string>",
  "getPreviewBuilds": true,
  "hasAndroidApp": true,
  "hasChromeExtension": true,
  "hasIosApp": true,
  "lastActive": "<string>",
  "lastName": "<string>",
  "latestReminderTime": "<string>",
  "loginName": "<string>",
  "password": "<string>",
  "phoneNumber": "<string>",
  "phoneVerificationCode": "<string>",
  "primaryOutcomeVariableId": 123,
  "primaryOutcomeVariableName": "<string>",
  "pushNotificationsEnabled": true,
  "sendPredictorEmails": true,
  "sendReminderNotificationEmails": true,
  "shareAllData": true,
  "smsNotificationsEnabled": true,
  "timeZoneOffset": 123,
  "trackLocation": true,
  "userUrl": "<string>"
}'

Authorizations

​
X-CLIENT-ID
string
header
required

Client ID for authentication from https://builder.dfda.earth

​
X-CLIENT-SECRET
string
header
required

Backend secret allowing you to store and retrieve data for your users. Obtain from https://builder.dfda.earth

Body

application/json
User info to update

The main thing you need here is the clientUserId that will be needed to fetch the user later.

​
clientUserId
string

The user id from your system so you can match the user in our system to the user in your system.

​
combineNotifications
boolean

Whether to combine notifications for multiple variables into a single notification

​
description
string

Your bio will be displayed on your published studies

​
displayName
string

User display name

​
earliestReminderTime
string

Earliest time user should get notifications. Ex: 05:00:00

​
email
string

User email

​
firstName
string

Ex: Mike

​
getPreviewBuilds
boolean

Whether the user should get preview builds of their custom app

​
hasAndroidApp
boolean

Whether the user has the Android app installed

​
hasChromeExtension
boolean

Whether the user has the Chrome extension installed

​
hasIosApp
boolean

Whether the user has the iOS app installed

​
lastActive
string

Ex: Date the user last logged in

​
lastName
string

Ex: Sinn

​
latestReminderTime
string

Latest time user should get notifications. Ex: 23:00:00

​
loginName
string

User login name

​
password
string

Ex: PASSWORD

​
phoneNumber
string

Ex: +1-618-555-0002

​
phoneVerificationCode
string

Ex: 1234

​
primaryOutcomeVariableId
integer

A good primary outcome variable is something that you want to improve and that changes inexplicably. For instance, if you have anxiety, back pain or arthritis which is worse on some days than others, these would be good candidates for primary outcome variables. Recording their severity and potential factors will help you identify hidden factors exacerbating or improving them.

​
primaryOutcomeVariableName
string

A good primary outcome variable is something that you want to improve and that changes inexplicably. For instance, if you have anxiety, back pain or arthritis which is worse on some days than others, these would be good candidates for primary outcome variables. Recording their severity and potential factors will help you identify hidden factors exacerbating or improving them.

​
pushNotificationsEnabled
boolean

Whether the user should get push notifications

​
sendPredictorEmails
boolean

Whether the user should get weekly emails on the factors most predictive of their primary outcome to improve

​
sendReminderNotificationEmails
boolean

Whether the user should get emails when they have tracking reminders

​
shareAllData
boolean

Share all studies, charts, and measurement data with all other users

​
smsNotificationsEnabled
boolean

Whether the user should get SMS notifications

​
timeZoneOffset
integer

Minutes offset from UTC time

​
trackLocation
boolean

Whether the user wants to automatically track their location with measurements

​
userUrl
string

The URL the user wants to associate with their account

Response

201

Successful operation