Skip to main content
POST
/
v1
/
members
Create new member
curl --request POST \
  --url https://api.halth.com/v1/members \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "[email protected]",
  "mobileNumber": "<string>",
  "dateOfBirth": "<string>",
  "profileImageUrl": "<string>",
  "metadata": {}
}
'
{
  "id": "<string>",
  "emailVerified": true,
  "mobileNumberVerified": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "mobileNumber": "<string>",
  "dateOfBirth": "<string>",
  "roles": [
    "<string>"
  ],
  "profileImageUrl": "<string>",
  "activity": [
    {
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "applicationId": "member_web",
      "createdAt": "2023-11-07T05:31:56Z",
      "applicationVersion": "<string>",
      "platform": "<string>",
      "userAgent": "<string>"
    }
  ]
}

Body

application/json
firstName
string
Maximum string length: 255
lastName
string
Maximum string length: 255
email
string<email>
Maximum string length: 255
mobileNumber
string
Maximum string length: 20
dateOfBirth
string
profileImageUrl
string<uri> | null
metadata
object

Response

201 - application/json
id
string
required
emailVerified
boolean
required
mobileNumberVerified
boolean
required
createdAt
string<date-time>
required
firstName
string
lastName
string
email
string
mobileNumber
string
dateOfBirth
string
roles
string[]
profileImageUrl
string
activity
object[]