Update a contact detail

PUT /api/v2/contact-details/{uuid}

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

uuid string Required

application/json

Body

name string

Description of contact detail
value string

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.
account_uuids array[string]

The UUIDs of the accounts who should own the contact detail. These must only be client accounts.
primary_account_uuids array[string]

The UUIDs of the accounts who should have the contact detail as their primary contact detail.

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- type string
  
  Contact detail type
- name string
  
  Contact detail description
- value string
  
  Contact detail value
- phone_number_meta object
  
  If the type is a phone number, this additional field will be displayed giving you information about the phone number.
  
  Hide phone_number_meta attributes Show phone_number_meta attributes object
  
  country string
  
  formatted string
- accounts object
  
  Accounts that own contact detail
  
  Hide accounts attributes Show accounts attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  firm string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  custom_fields string
  
  external_references string

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":["215bfac7-218c-4037-b16f-06e8bd97f6bd","0399d381-a546-4ed3-a554-2a047fe30ba9"],"primary_account_uuids":["1eba87f1-addd-42cc-97e7-0fc2c50f4204","9a80b589-b5fb-49b8-88f7-8e7c44e0c82d"]}'

Request examples

# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Work phone number",
  "value": "+443330903630",
  "account_uuids": [
    "215bfac7-218c-4037-b16f-06e8bd97f6bd",
    "0399d381-a546-4ed3-a554-2a047fe30ba9"
  ],
  "primary_account_uuids": [
    "1eba87f1-addd-42cc-97e7-0fc2c50f4204",
    "9a80b589-b5fb-49b8-88f7-8e7c44e0c82d"
  ]
}

Response examples (200)

{
  "name": "Work number",
  "type": "phone_number",
  "uuid": "a174c983-9100-45bb-9e27-4d8094c64a8c",
  "value": "+443330903630",
  "accounts": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "822a8363-9201-4600-9a38-83232dcd18cb",
    "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"
  }
}