family_management

assign

Links another ABHA address to the signed-in person's address under a relationship type, so the two profiles are managed as a family.

POST/api/family-management/assign

Authorizations

Authorizationbearer tokenRequired

The access token from POST /api/hiecm/gateway/v3/sessions.

Body

relatedAbhaAddressstringRequired

relationshipTypeIdintegerRequired

Responses

200

Example values, scrubbed.

400

Example values, scrubbed.

Error codes for this module

500

Example values, scrubbed.

Error codes for this module

assign

curl --request POST \
  --url https://phrsbx.abdm.gov.in/api/family-management/assign \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "relatedAbhaAddress": "nithishnov@sbx",
  "relationshipTypeId": 2
}'

{
  "message": "Relationship assigned successfully",
  "success": true,
  "relationshipId": null
}

Generated from the schema. The values are placeholders, not a captured response.