Member Create

API URL

{{url}}/spice-service/household/create-member

Method

POST

Description

Creation of household member

Input:

Field Name

Type

Mandatory

Example

Authorization (Header)

String

Yes

Bearer 1ba363a1edf54402b51f58060aa52b11d30f99a490295adec900fdabf2b472181c0bfb165be18f4f5c430c7218a244bd29b9300d3471acc08197ccfb996118f6

client

String

Yes

mob

household

String

Yes

Household details

householdMember

String

Yes

Household Member details

createdAt

Date

Yes

Created At

dateOfBirth

Date

Yes

DateOfBirth of member

gender

String

Yes

Gender of Household member

householdHeadRelationship

String

Yes

Household Head Relationship

householdReferenceId

Bigint

Yes

Household Reference Id

isActive

Boolean

Yes

Is Active

isChild

Boolean

Yes

Is Child validation

isPregnant

Boolean

Yes

Is Pregnant check

latitude

Double

Yes

Location details

longitude

Double

Yes

longitude details

name

String

Yes

Household name

phoneNumber

Bigint

Yes

Phone Number

phoneNumberCategory

String

Yes

PhoneNumber Category

provenance

String

Yes

Provenance details

referenceId

Bigint

Yes

Reference ID for household member

village

String

Yes

Village name

villageId

Bigint

Yes

Village id for household

Sample Input:

{ "dateOfBirth": "1993-01-27T00:00:00+00:00", "gender": "female", "householdHeadRelationship": "Wife / Husband", "householdId": "1", "householdReferenceId": "2", "isActive": true, "isChild": false, "isPregnant": true, "latitude": 37.4219983, "longitude": -122.084, "name": "lili", "phoneNumber": "21XXXX231", "phoneNumberCategory": "Personal", "provenance": { "modifiedDate": "2025-101-27T06:41:36.718Z", "organizationId": "1", "spiceUserId": 2, "userId": "3" }, "referenceId": "4", "updatedAt": 1737960096718, "village": "Clergy", "villageId": 5 }

Output:

Field Name

Type

Comments

Message

String

Household Member Created Successfully

Sample Output:

{
  "message": "HouseHold Member Created Successfully.",
  "entity": null,
  "status": true,
  "entityList": null,
  "responseCode": 201,
  "totalCount": null
}

Last updated