Afya-Health
  1. Family Members
Afya-Health
  • Auth
    • Login
      POST
    • Signup
      POST
  • ForgotPassword
    • Verify OTP
      POST
    • ForgotPassword
      POST
    • ResetPassword
      POST
  • Profile
    • Get User Profile
      GET
    • Update user profile
      POST
  • Family Members
    • Add Family Member
      POST
    • Update Family Members
      PUT
    • Delete Family Member
      DELETE
  • Address
    • Get User address
      GET
    • Add Address
      POST
    • Update address
      PUT
    • Delete Address
      DELETE
  • Languages
    • List AppLabels
      GET
    • Add/Update Label
      POST
    • List Languages
      GET
  • Products
    • Get Products
      GET
    • Create Product
      POST
    • Update Product
      PUT
    • Delete Product
      DELETE
    • Update product items
      PUT
  • Permissions
    • Get Permissions
  • Config
    • List Practice Config
    • Add Update Config
    • List Master Config
    • Add Update Master Config
  • Appointment Schedule
    • Create Schedule
    • Update Schedule
    • Delete Schedule
    • Get Schedule by ID
    • Get Schedule list
  • Test Tags
    • Get Test Tags
    • Create Test Tag
    • Update Test Tag
    • Delete Test Tag
  • Test Parameters
    • Get Test Parameters
    • Create Test Parameters
    • Update Test Parameters
    • Delete Test Parameters
  • Category
    • Get Category
    • Create Category
    • Update Category
    • Delete Category
  • Device
    • Register Device
  • File
    • Upload File
  • Appointment
    • Create Appointment Order
    • Get Appointments List
    • Update Appointment Status
    • Get Appointment by ID
    • Get Appointment Slots
    • GetStartJourneyDirection
  • Reports
    • Upload Report
    • List All Reports
    • List Reports By Appointment
    • Delete Report
    • Update Report File
  • Staff
    • Add Staff Member
    • List Staff Member
    • Update Staff Member
    • Delete Staff Member
    • Get Staff member by ID
  • Patient
    • List Patients
    • Add Patient
    • Update Patient
    • Delete Patient
    • Get patient by ID
  • Notifications
    • List User Notifications
    • Update Notification read status
  1. Family Members

Add Family Member

Developing
POST
/api/service/v1/user/family-members

Request

Header Params
Content-Type
string 
optional
Example:
application/json
Accept
string 
optional
Example:
application/json
Authorization
string 
optional
Example:
{{token}}
Body Params application/json
name
string 
required
birth_date
string 
required
gender
string 
required
Example
{
    "name" :"test1",
    "birth_date" : "2000-01-01",
    "gender" : "male"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://afyahealth.doctodoor.com:5600/api/service/v1/user/family-members' \
--header 'Accept: application/json' \
--header 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3YjJkZmZlNWJmMjdlMzk1NTUzMjE0MyIsImVtYWlsIjoiZGVlcC5tYXJzb25pYUBwbGVuYXJ0ZWNoLmNvbSIsInN1YiI6IjY3YjJkZmZlNWJmMjdlMzk1NTUzMjE0MyIsImlhdCI6MTc0MTc4MjA4NCwiZXhwIjoxNzQ5NTU4MDg0fQ.KAMsweSbJPDxpLijKdjgp3YEFauw8KYLLumCBpqQfAA' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name" :"test1",
    "birth_date" : "2000-01-01",
    "gender" : "male"
}'

Responses

🟢200Success
application/json
Body
error
boolean 
required
status_code
integer 
required
message
string 
required
data
object 
required
roles
array[string]
required
is_master_admin
integer 
required
is_deleted
integer 
required
is_active
integer 
required
deleted_at
null 
required
language_code
string 
required
first_name
string 
required
middle_name
string 
required
last_name
string 
required
full_name
string 
required
email
string 
required
created_at
string 
required
updated_at
string 
required
family_members
array [object {4}] 
required
id
string 
required
Examples
{
    "error": false,
    "status_code": 200,
    "message": "Address Added Success",
    "data": {
        "roles": [
            {
                "practice": "677bb5bd4291b96cd0623e93",
                "deleted_at": null,
                "is_deleted": 0,
                "name": "Master Admin",
                "slug": "master_admin",
                "created_at": "2025-01-06T10:51:41.298Z",
                "updated_at": "2025-01-06T10:51:41.298Z",
                "id": "677bb5bd4291b96cd0623e9e"
            }
        ],
        "is_master_admin": 1,
        "is_deleted": 0,
        "is_active": 1,
        "deleted_at": null,
        "language_code": "en",
        "first_name": "Deep",
        "middle_name": "",
        "last_name": "Marsonia",
        "full_name": "Deep Marsonia",
        "email": "deep.marsonia@plenartech.com",
        "created_at": "2025-01-06T10:51:41.439Z",
        "updated_at": "2025-01-23T07:03:19.252Z",
        "family_members": [
            {
                "_id": "678f6be2b92fcb53c701b2b1",
                "name": "test2",
                "gender": "male",
                "birth_date": "2000-01-01T00:00:00.000Z"
            },
            {
                "_id": "6791e9b7f48f3f49106b3236",
                "name": "test2",
                "gender": "male",
                "birth_date": "2000-01-01T00:00:00.000Z"
            }
        ],
        "id": "677bb5bd4291b96cd0623eea"
    }
}
Previous
Update user profile
Next
Update Family Members
Built with