Body
-
Description of contact detail
-
Value of contact detail. If the type is phone number, the format defaults to GB. You can provide an array
["country" => "AU", "number" => "+61 2 3456 7890"]
if you want to use a different format. -
The UUIDs of the accounts who should own the contact detail. These must only be client accounts.
-
The UUIDs of the accounts who should have the contact detail as their primary contact detail.
PUT
/api/v2/contact-details/{uuid}
curl \
--request PUT 'https://api.plannrcrm.com/api/v2/contact-details/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"name":"Work phone number","value":"+443330903630","account_uuids":["5516ed17-4c3f-40ae-84b8-41830adcaa0d","17a83b3f-66b5-4a5d-9c81-66e51bf21635"],"primary_account_uuids":["d348a989-db48-4c62-92c9-c5ec90ed78d6","e898ae32-9396-4446-a259-4687d94e8760"]}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"name": "Work phone number",
"value": "+443330903630",
"account_uuids": [
"5516ed17-4c3f-40ae-84b8-41830adcaa0d",
"17a83b3f-66b5-4a5d-9c81-66e51bf21635"
],
"primary_account_uuids": [
"d348a989-db48-4c62-92c9-c5ec90ed78d6",
"e898ae32-9396-4446-a259-4687d94e8760"
]
}
Response examples (200)
{
"name": "Work number",
"type": "phone_number",
"uuid": "ce87761a-615b-4630-a7c7-6334dff17e07",
"value": "+443330903630",
"accounts": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "b9bb3713-a596-4bc9-a848-66f2c3efa0b5",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-10-08T10:40:17+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-08T10:40:17+01:00",
"with_login": true,
"inactive_at": "2025-10-08",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-10-08T10:40:17+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-10-08T10:40:17+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-10-08T10:40:17+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-10-08T10:40:17+01:00"
},
"created_at": "2025-10-08T10:40:17+01:00",
"updated_at": "2025-10-08T10:40:17+01:00",
"phone_number_meta": {
"country": "GB",
"formatted": "0333 090 3630"
}
}