Update a contact detail

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

Personal access token & O auth2

Headers

Path parameters

id string Required

The ID of the contact detail.

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. These must only be client accounts.

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.
- accounts object
  
  Accounts that own contact detail

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

curl \
 --request PUT 'https://api.plannrcrm.com/api/v2/contact-details/id' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"name":"Work phone number","value":"+443330903630","account_uuids":["b87c5b34-dd88-485c-aef1-d3b2cc0096ad","7ba6c782-56fe-43df-a03a-49662b9ca5b1"],"primary_account_uuids":["2ee5d473-7e80-44fd-994a-fe6d28dae164","48451fd8-c02f-4d7e-9311-6f0799145cc5"]}'

Request examples

# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Work phone number",
  "value": "+443330903630",
  "account_uuids": [
    "b87c5b34-dd88-485c-aef1-d3b2cc0096ad",
    "7ba6c782-56fe-43df-a03a-49662b9ca5b1"
  ],
  "primary_account_uuids": [
    "2ee5d473-7e80-44fd-994a-fe6d28dae164",
    "48451fd8-c02f-4d7e-9311-6f0799145cc5"
  ]
}

Response examples (200)

{
  "name": "Work number",
  "type": "phone_number",
  "uuid": "ad54e43a-8f79-4f84-a3dd-802b65cbb81a",
  "value": "+443330903630",
  "accounts": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "7f142b4d-4500-4a0f-8c2a-2b42595a4635",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-04-02T13:27:59+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-02T13:27:59+01:00",
    "with_login": true,
    "inactive_at": "2025-04-02",
    "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-04-02T13:27:59+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-04-02T13:27:59+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-04-02T13:27:59+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-04-02T13:27:59+01:00"
  },
  "created_at": "2025-04-02T13:27:59+01:00",
  "updated_at": "2025-04-02T13:27:59+01:00",
  "phone_number_meta": {
    "country": "GB",
    "formatted": "0333 090 3630"
  }
}