Body
Required
-
Valid types: email and phone_number
-
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. -
Make this contact type the primary contact. Will make all other contact details of the same type no longer primary.
-
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.
POST
/api/v2/contact-details
curl \
--request POST 'https://api.plannrcrm.com/api/v2/contact-details' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"type":"phone_number","name":"Work phone number","value":"+443330903630","is_primary":true,"account_uuids":["0aa5c83b-4bfe-4da8-ab76-99820fd538a5","77ff61bd-5a09-44d6-8506-890dc3b28126"],"primary_account_uuids":["2c895a04-7d9d-40b8-9d90-c8245f0f343a","397679df-8ac3-4a72-9bcf-5ce15bec606e"]}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"type": "phone_number",
"name": "Work phone number",
"value": "+443330903630",
"is_primary": true,
"account_uuids": [
"0aa5c83b-4bfe-4da8-ab76-99820fd538a5",
"77ff61bd-5a09-44d6-8506-890dc3b28126"
],
"primary_account_uuids": [
"2c895a04-7d9d-40b8-9d90-c8245f0f343a",
"397679df-8ac3-4a72-9bcf-5ce15bec606e"
]
}
Response examples (201)
{
"name": "Work number",
"type": "phone_number",
"uuid": "c20ac108-910c-4148-a020-ec51ee33bc96",
"value": "+443330903630",
"accounts": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "f476deb9-af49-44fb-ae33-74bfbd1219ea",
"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-24T10:34:20+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-24T10:34:20+01:00",
"with_login": true,
"inactive_at": "2025-10-24",
"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-24T10:34:20+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-10-24T10:34:20+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-24T10:34:20+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-10-24T10:34:20+01:00"
},
"created_at": "2025-10-24T10:34:20+01:00",
"updated_at": "2025-10-24T10:34:20+01:00",
"phone_number_meta": {
"country": "GB",
"formatted": "0333 090 3630"
}
}