curl --request POST \
--url https://api.wellapp.ai/v1/people \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "people",
"attributes": {
"first_name": "Sophie",
"last_name": "Martin"
},
"relationships": {
"emails": {
"data": [
{
"type": "email",
"id": "temp-email-1"
},
{
"type": "email",
"id": "temp-email-2"
}
]
},
"phones": {
"data": [
{
"type": "phone",
"id": "temp-phone-1"
}
]
},
"social_links": {
"data": [
{
"type": "social_link",
"id": "temp-social-1"
}
]
},
"companies": {
"data": [
{
"type": "company",
"id": "temp-company-1",
"meta": {
"relationship_type": "employee"
}
}
]
}
},
"included": [
{
"type": "email",
"id": "temp-email-1",
"attributes": {
"value": "sophie.martin@example.com",
"label": "work",
"is_primary": true
}
},
{
"type": "email",
"id": "temp-email-2",
"attributes": {
"value": "sophie@personal.com",
"label": "personal",
"is_primary": false
}
},
{
"type": "phone",
"id": "temp-phone-1",
"attributes": {
"e164_number": "+33123456789",
"label": "mobile",
"is_primary": true
}
},
{
"type": "social_link",
"id": "temp-social-1",
"attributes": {
"url": "https://linkedin.com/in/sophie-martin",
"platform": "linkedin"
}
},
{
"type": "company",
"id": "temp-company-1",
"attributes": {
"name": "Example Corp",
"description": "Tech company",
"workspace_id": "550e8400-e29b-41d4-a716-446655440001"
}
}
]
}
'{
"data": {
"type": "people",
"id": "3e29b483-e8a0-4871-906e-5ddfc9b7ed6b",
"attributes": {
"first_name": "Sophie",
"last_name": "Martin",
"full_name": "Sophie Martin",
"created_at": "2025-09-15T14:09:40.942Z"
},
"relationships": {
"emails": {
"data": [
{
"type": "email",
"id": "471604cd-8de8-4576-97f7-7c4656d7b6b4"
},
{
"type": "email",
"id": "9cbefca9-32bb-48d0-aeee-c07fa84ad0b8"
}
]
},
"phones": {
"data": [
{
"type": "phone",
"id": "11175a7a-df1a-4f9d-bb2a-9d6023f15bf8"
},
{
"type": "phone",
"id": "ae72063c-861f-489e-973d-83e31cef24f8"
}
]
},
"social_links": {
"data": [
{
"type": "social_link",
"id": "c401d53e-ca36-47e7-a861-83443599eb4c"
}
]
},
"companies": {
"data": [
{
"type": "company",
"id": "b6c22e98-c8d0-485e-9d3d-caa2bbaff77a"
}
]
}
}
},
"included": [
{
"type": "email",
"id": "471604cd-8de8-4576-97f7-7c4656d7b6b4",
"attributes": {
"value": "sophie.perso@gmail.com",
"label": "personal",
"is_primary": false,
"created_at": "2025-09-15T14:09:40.963Z"
}
},
{
"type": "email",
"id": "9cbefca9-32bb-48d0-aeee-c07fa84ad0b8",
"attributes": {
"value": "sophie.martin@company.com",
"label": "work",
"is_primary": true,
"created_at": "2025-09-15T14:09:40.953Z"
}
},
{
"type": "phone",
"id": "11175a7a-df1a-4f9d-bb2a-9d6023f15bf8",
"attributes": {
"e164_number": "+33646020535",
"country_code": 33,
"national_number": "646020535",
"is_primary": true,
"is_verify": false,
"label": "mobile",
"created_at": "2025-09-15T14:09:40.973Z"
}
},
{
"type": "phone",
"id": "ae72063c-861f-489e-973d-83e31cef24f8",
"attributes": {
"e164_number": "+33142356789",
"country_code": 33,
"national_number": "142356789",
"is_primary": false,
"is_verify": false,
"label": "work",
"created_at": "2025-09-15T14:09:40.981Z"
}
},
{
"type": "social_link",
"id": "c401d53e-ca36-47e7-a861-83443599eb4c",
"attributes": {
"url": "https://linkedin.com/in/sophie-martin",
"platform": "linkedin",
"created_at": "2025-09-15T14:09:40.990Z"
}
},
{
"type": "company",
"id": "b6c22e98-c8d0-485e-9d3d-caa2bbaff77a",
"attributes": {
"name": "TechCorp Solutions",
"description": "Leading technology consulting company",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000",
"created_at": "2025-09-15T14:09:40.995Z"
}
}
]
}Create Person
Create a new person record with optional emails, phone numbers, company relationships, and social links. If a person with the same name and primary email already exists, returns the existing person instead of creating a duplicate.
curl --request POST \
--url https://api.wellapp.ai/v1/people \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "people",
"attributes": {
"first_name": "Sophie",
"last_name": "Martin"
},
"relationships": {
"emails": {
"data": [
{
"type": "email",
"id": "temp-email-1"
},
{
"type": "email",
"id": "temp-email-2"
}
]
},
"phones": {
"data": [
{
"type": "phone",
"id": "temp-phone-1"
}
]
},
"social_links": {
"data": [
{
"type": "social_link",
"id": "temp-social-1"
}
]
},
"companies": {
"data": [
{
"type": "company",
"id": "temp-company-1",
"meta": {
"relationship_type": "employee"
}
}
]
}
},
"included": [
{
"type": "email",
"id": "temp-email-1",
"attributes": {
"value": "sophie.martin@example.com",
"label": "work",
"is_primary": true
}
},
{
"type": "email",
"id": "temp-email-2",
"attributes": {
"value": "sophie@personal.com",
"label": "personal",
"is_primary": false
}
},
{
"type": "phone",
"id": "temp-phone-1",
"attributes": {
"e164_number": "+33123456789",
"label": "mobile",
"is_primary": true
}
},
{
"type": "social_link",
"id": "temp-social-1",
"attributes": {
"url": "https://linkedin.com/in/sophie-martin",
"platform": "linkedin"
}
},
{
"type": "company",
"id": "temp-company-1",
"attributes": {
"name": "Example Corp",
"description": "Tech company",
"workspace_id": "550e8400-e29b-41d4-a716-446655440001"
}
}
]
}
'{
"data": {
"type": "people",
"id": "3e29b483-e8a0-4871-906e-5ddfc9b7ed6b",
"attributes": {
"first_name": "Sophie",
"last_name": "Martin",
"full_name": "Sophie Martin",
"created_at": "2025-09-15T14:09:40.942Z"
},
"relationships": {
"emails": {
"data": [
{
"type": "email",
"id": "471604cd-8de8-4576-97f7-7c4656d7b6b4"
},
{
"type": "email",
"id": "9cbefca9-32bb-48d0-aeee-c07fa84ad0b8"
}
]
},
"phones": {
"data": [
{
"type": "phone",
"id": "11175a7a-df1a-4f9d-bb2a-9d6023f15bf8"
},
{
"type": "phone",
"id": "ae72063c-861f-489e-973d-83e31cef24f8"
}
]
},
"social_links": {
"data": [
{
"type": "social_link",
"id": "c401d53e-ca36-47e7-a861-83443599eb4c"
}
]
},
"companies": {
"data": [
{
"type": "company",
"id": "b6c22e98-c8d0-485e-9d3d-caa2bbaff77a"
}
]
}
}
},
"included": [
{
"type": "email",
"id": "471604cd-8de8-4576-97f7-7c4656d7b6b4",
"attributes": {
"value": "sophie.perso@gmail.com",
"label": "personal",
"is_primary": false,
"created_at": "2025-09-15T14:09:40.963Z"
}
},
{
"type": "email",
"id": "9cbefca9-32bb-48d0-aeee-c07fa84ad0b8",
"attributes": {
"value": "sophie.martin@company.com",
"label": "work",
"is_primary": true,
"created_at": "2025-09-15T14:09:40.953Z"
}
},
{
"type": "phone",
"id": "11175a7a-df1a-4f9d-bb2a-9d6023f15bf8",
"attributes": {
"e164_number": "+33646020535",
"country_code": 33,
"national_number": "646020535",
"is_primary": true,
"is_verify": false,
"label": "mobile",
"created_at": "2025-09-15T14:09:40.973Z"
}
},
{
"type": "phone",
"id": "ae72063c-861f-489e-973d-83e31cef24f8",
"attributes": {
"e164_number": "+33142356789",
"country_code": 33,
"national_number": "142356789",
"is_primary": false,
"is_verify": false,
"label": "work",
"created_at": "2025-09-15T14:09:40.981Z"
}
},
{
"type": "social_link",
"id": "c401d53e-ca36-47e7-a861-83443599eb4c",
"attributes": {
"url": "https://linkedin.com/in/sophie-martin",
"platform": "linkedin",
"created_at": "2025-09-15T14:09:40.990Z"
}
},
{
"type": "company",
"id": "b6c22e98-c8d0-485e-9d3d-caa2bbaff77a",
"attributes": {
"name": "TechCorp Solutions",
"description": "Leading technology consulting company",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000",
"created_at": "2025-09-15T14:09:40.995Z"
}
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.wellapp.ai/llms.txt
Use this file to discover all available pages before exploring further.
Headers
Bearer token for authentication
Body
Central entity representing individuals with comprehensive contact information
Unique person identifier (UUID v4)
"550e8400-e29b-41d4-a716-446655440000"
JSON:API resource type identifier
"people"Person attribute data
Show child attributes
Show child attributes
Person relationship references
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Person created successfully
Show child attributes
Show child attributes