Follow up
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pageintegerOptional
A page number within the paginated result set.
page_sizeintegerOptional
Number of results to return per page.
Responses
200Success
application/json
get
/api/users/follow-up200Success
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idstring · uuidRead-onlyRequired
assigned_userstring · uuidWrite-onlyOptional
legacy_idstring · nullableOptional
nextgen_legacy_idstring · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-timeRead-onlyRequired
salutationstring · max: 50 · nullableOptional
first_namestring · max: 100Required
last_namestring · max: 100Required
full_namestring · nullableRead-onlyRequired
emailstring · email · max: 254 · nullableOptional
phonestring · nullableOptional
call_timeone of · nullableOptional
string · enumOptionalPossible values:
morning- Morning (9AM-12PM)evening- Evening (5PM-8PM)afternoon- Afternoon (1PM-4PM)others- Other (Anytime between 9AM-8PM)
undefined · enumOptionalPossible values:
undefined · enumOptionalPossible values:
genderone of · nullableOptional
string · enumOptionalPossible values:
male- Malefemale- Female
undefined · enumOptionalPossible values:
undefined · enumOptionalPossible values:
address_1string · nullableOptional
address_2string · nullableOptional
citystring · nullableOptional
statestring · nullableOptional
zipstring · max: 6 · nullableOptional
requeststring · nullableOptional
invite_typestring · nullableOptional
birth_datestring · date · nullableOptional
age_groupstring · nullableOptional
statusstring · nullableOptional
activity_logany · nullableOptional
churchstring · uuidRequired
inviterstring · uuid · nullableOptional
userstring · uuid · nullableOptional
Responses
201Success
application/json
post
/api/users/follow-up201Success
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired
A UUID string identifying this guest.
Responses
200Success
application/json
get
/api/users/follow-up/{id}200Success
put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired
A UUID string identifying this guest.
Body
idstring · uuidRead-onlyRequired
assigned_userstring · uuidWrite-onlyOptional
legacy_idstring · nullableOptional
nextgen_legacy_idstring · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-timeRead-onlyRequired
salutationstring · max: 50 · nullableOptional
first_namestring · max: 100Required
last_namestring · max: 100Required
full_namestring · nullableRead-onlyRequired
emailstring · email · max: 254 · nullableOptional
phonestring · nullableOptional
call_timeone of · nullableOptional
string · enumOptionalPossible values:
morning- Morning (9AM-12PM)evening- Evening (5PM-8PM)afternoon- Afternoon (1PM-4PM)others- Other (Anytime between 9AM-8PM)
undefined · enumOptionalPossible values:
undefined · enumOptionalPossible values:
genderone of · nullableOptional
string · enumOptionalPossible values:
male- Malefemale- Female
undefined · enumOptionalPossible values:
undefined · enumOptionalPossible values:
address_1string · nullableOptional
address_2string · nullableOptional
citystring · nullableOptional
statestring · nullableOptional
zipstring · max: 6 · nullableOptional
requeststring · nullableOptional
invite_typestring · nullableOptional
birth_datestring · date · nullableOptional
age_groupstring · nullableOptional
statusstring · nullableOptional
activity_logany · nullableOptional
churchstring · uuidRequired
inviterstring · uuid · nullableOptional
userstring · uuid · nullableOptional
Responses
200Success
application/json
put
/api/users/follow-up/{id}200Success
delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired
A UUID string identifying this guest.
Responses
204
No response body
delete
/api/users/follow-up/{id}204
No response body
No content
patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired
A UUID string identifying this guest.
Body
idstring · uuidRead-onlyOptional
assigned_userstring · uuidWrite-onlyOptional
legacy_idstring · nullableOptional
nextgen_legacy_idstring · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-timeRead-onlyOptional
salutationstring · max: 50 · nullableOptional
first_namestring · max: 100Optional
last_namestring · max: 100Optional
full_namestring · nullableRead-onlyOptional
emailstring · email · max: 254 · nullableOptional
phonestring · nullableOptional
call_timeone of · nullableOptional
string · enumOptionalPossible values:
morning- Morning (9AM-12PM)evening- Evening (5PM-8PM)afternoon- Afternoon (1PM-4PM)others- Other (Anytime between 9AM-8PM)
undefined · enumOptionalPossible values:
undefined · enumOptionalPossible values:
genderone of · nullableOptional
string · enumOptionalPossible values:
male- Malefemale- Female
undefined · enumOptionalPossible values:
undefined · enumOptionalPossible values:
address_1string · nullableOptional
address_2string · nullableOptional
citystring · nullableOptional
statestring · nullableOptional
zipstring · max: 6 · nullableOptional
requeststring · nullableOptional
invite_typestring · nullableOptional
birth_datestring · date · nullableOptional
age_groupstring · nullableOptional
statusstring · nullableOptional
activity_logany · nullableOptional
churchstring · uuidOptional
inviterstring · uuid · nullableOptional
userstring · uuid · nullableOptional
Responses
200Success
application/json
patch
/api/users/follow-up/{id}200Success