Profile
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200Success
application/json
get
/api/users/profile200Success
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idstringRead-onlyRequired
additional_profile_fieldsstringRead-onlyRequired
birth_datestring · nullableOptional
wedding_anniversarystring · nullableOptional
first_namestring · max: 50Required
middle_namestring · max: 50 · nullableOptional
last_namestring · max: 50Required
full_namestring · nullableRead-onlyRequired
avatarstring · max: 255 · nullableOptional
job_titlestring · max: 100 · nullableOptional
salutationstring · max: 50 · nullableOptional
positionsanyOptional
genderone of · nullableOptional
string · enumOptionalPossible values:
male- Malefemale- Female
undefined · enumOptionalPossible values:
undefined · enumOptionalPossible values:
marital_statusone of · nullableOptional
string · enumOptionalPossible values:
married- Marrieddivorced- Divorcedsingle- Singlewidowed- Widowedother- Other
undefined · enumOptionalPossible values:
undefined · enumOptionalPossible values:
employment_statusstring · max: 50 · nullableOptional
employment_industrystring · nullableOptional
address_1string · nullableOptional
address_2string · nullableOptional
citystring · nullableOptional
statestring · nullableOptional
countrystring · nullableOptional
zipstring · nullableOptional
cover_photostring · uri · max: 256 · nullableOptional
is_teacherbooleanOptional
has_email_notifications_for_informationbooleanOptional
has_email_notifications_for_confirmationbooleanOptional
has_email_notifications_for_warningsbooleanOptional
has_push_notifications_for_informationbooleanOptional
has_push_notifications_for_confirmationbooleanOptional
has_push_notifications_for_warningsbooleanOptional
is_testimony_reviewerbooleanOptional
is_prayer_request_reviewerbooleanOptional
is_leaderbooleanOptional
is_follow_up_managerbooleanOptional
is_follow_up_memberbooleanOptional
aboutstring · nullableOptional
notestring · nullableOptional
envelope_idstring · nullableOptional
is_speakerbooleanOptional
is_developerbooleanOptional
baptismbooleanOptional
nationalitystring · max: 50 · nullableOptional
age_groupstring · max: 50 · nullableOptional
hobbiesanyOptional
allergiesanyOptional
medicationsanyOptional
medical_conditionstring · nullableOptional
password_updated_atstring · date-time · nullableOptional
session_timeoutinteger · min: -2147483648 · max: 2147483647 · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-timeRead-onlyRequired
spousestring · uuid · nullableOptional
Responses
201Success
application/json
post
/api/users/profile201Success
put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userstring · uuidRequired
A unique value identifying this profile.
Body
idstringRead-onlyRequired
additional_profile_fieldsstringRead-onlyRequired
birth_datestring · nullableOptional
wedding_anniversarystring · nullableOptional
first_namestring · max: 50Required
middle_namestring · max: 50 · nullableOptional
last_namestring · max: 50Required
full_namestring · nullableRead-onlyRequired
avatarstring · max: 255 · nullableOptional
job_titlestring · max: 100 · nullableOptional
salutationstring · max: 50 · nullableOptional
positionsanyOptional
genderone of · nullableOptional
string · enumOptionalPossible values:
male- Malefemale- Female
undefined · enumOptionalPossible values:
undefined · enumOptionalPossible values:
marital_statusone of · nullableOptional
string · enumOptionalPossible values:
married- Marrieddivorced- Divorcedsingle- Singlewidowed- Widowedother- Other
undefined · enumOptionalPossible values:
undefined · enumOptionalPossible values:
employment_statusstring · max: 50 · nullableOptional
employment_industrystring · nullableOptional
address_1string · nullableOptional
address_2string · nullableOptional
citystring · nullableOptional
statestring · nullableOptional
countrystring · nullableOptional
zipstring · nullableOptional
cover_photostring · uri · max: 256 · nullableOptional
is_teacherbooleanOptional
has_email_notifications_for_informationbooleanOptional
has_email_notifications_for_confirmationbooleanOptional
has_email_notifications_for_warningsbooleanOptional
has_push_notifications_for_informationbooleanOptional
has_push_notifications_for_confirmationbooleanOptional
has_push_notifications_for_warningsbooleanOptional
is_testimony_reviewerbooleanOptional
is_prayer_request_reviewerbooleanOptional
is_leaderbooleanOptional
is_follow_up_managerbooleanOptional
is_follow_up_memberbooleanOptional
aboutstring · nullableOptional
notestring · nullableOptional
envelope_idstring · nullableOptional
is_speakerbooleanOptional
is_developerbooleanOptional
baptismbooleanOptional
nationalitystring · max: 50 · nullableOptional
age_groupstring · max: 50 · nullableOptional
hobbiesanyOptional
allergiesanyOptional
medicationsanyOptional
medical_conditionstring · nullableOptional
password_updated_atstring · date-time · nullableOptional
session_timeoutinteger · min: -2147483648 · max: 2147483647 · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-timeRead-onlyRequired
spousestring · uuid · nullableOptional
Responses
200Success
application/json
put
/api/users/profile/{user}200Success
patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userstring · uuidRequired
A unique value identifying this profile.
Body
idstringRead-onlyOptional
additional_profile_fieldsstringRead-onlyOptional
birth_datestring · nullableOptional
wedding_anniversarystring · nullableOptional
first_namestring · max: 50Optional
middle_namestring · max: 50 · nullableOptional
last_namestring · max: 50Optional
full_namestring · nullableRead-onlyOptional
avatarstring · max: 255 · nullableOptional
job_titlestring · max: 100 · nullableOptional
salutationstring · max: 50 · nullableOptional
positionsanyOptional
genderone of · nullableOptional
string · enumOptionalPossible values:
male- Malefemale- Female
undefined · enumOptionalPossible values:
undefined · enumOptionalPossible values:
marital_statusone of · nullableOptional
string · enumOptionalPossible values:
married- Marrieddivorced- Divorcedsingle- Singlewidowed- Widowedother- Other
undefined · enumOptionalPossible values:
undefined · enumOptionalPossible values:
employment_statusstring · max: 50 · nullableOptional
employment_industrystring · nullableOptional
address_1string · nullableOptional
address_2string · nullableOptional
citystring · nullableOptional
statestring · nullableOptional
countrystring · nullableOptional
zipstring · nullableOptional
cover_photostring · uri · max: 256 · nullableOptional
is_teacherbooleanOptional
has_email_notifications_for_informationbooleanOptional
has_email_notifications_for_confirmationbooleanOptional
has_email_notifications_for_warningsbooleanOptional
has_push_notifications_for_informationbooleanOptional
has_push_notifications_for_confirmationbooleanOptional
has_push_notifications_for_warningsbooleanOptional
is_testimony_reviewerbooleanOptional
is_prayer_request_reviewerbooleanOptional
is_leaderbooleanOptional
is_follow_up_managerbooleanOptional
is_follow_up_memberbooleanOptional
aboutstring · nullableOptional
notestring · nullableOptional
envelope_idstring · nullableOptional
is_speakerbooleanOptional
is_developerbooleanOptional
baptismbooleanOptional
nationalitystring · max: 50 · nullableOptional
age_groupstring · max: 50 · nullableOptional
hobbiesanyOptional
allergiesanyOptional
medicationsanyOptional
medical_conditionstring · nullableOptional
password_updated_atstring · date-time · nullableOptional
session_timeoutinteger · min: -2147483648 · max: 2147483647 · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-timeRead-onlyOptional
spousestring · uuid · nullableOptional
Responses
200Success
application/json
patch
/api/users/profile/{user}200Success