Update a contact detail

PUT /api/v2/contact-details/{id}
Personal access token & O auth2

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.

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":["9c950b11-c785-4dea-a474-a9930d46b6e2","0b36ba57-761d-4756-b18a-273b6a300af6"],"primary_account_uuids":["ec12a620-6729-4831-809b-3d8a3dde8c45","0473a51a-94e2-481e-8e81-fb0e6caf4d7b"]}'
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": [
    "9c950b11-c785-4dea-a474-a9930d46b6e2",
    "0b36ba57-761d-4756-b18a-273b6a300af6"
  ],
  "primary_account_uuids": [
    "ec12a620-6729-4831-809b-3d8a3dde8c45",
    "0473a51a-94e2-481e-8e81-fb0e6caf4d7b"
  ]
}
Response examples (200) 
{
  "name": "Work number",
  "type": "phone_number",
  "uuid": "54dfc44f-ec67-441e-a68a-6a4bfa03a92e",
  "value": "+443330903630",
  "accounts": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "1f4f20ca-ed1d-40fe-8e28-815d817edff4",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-06-05T11:39:43+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-06-05T11:39:43+01:00",
    "with_login": true,
    "inactive_at": "2025-06-05",
    "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-06-05T11:39:43+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-06-05T11:39:43+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-06-05T11:39:43+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-06-05T11:39:43+01:00"
  },
  "created_at": "2025-06-05T11:39:43+01:00",
  "updated_at": "2025-06-05T11:39:43+01:00",
  "phone_number_meta": {
    "country": "GB",
    "formatted": "0333 090 3630"
  }
}