POST /api/v2/contact-details
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string
application/json

Body Required

  • type string Required

    Valid types: email and phone_number

  • name string Required

    Description of contact detail

  • value string Required

    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.

  • is_primary boolean

    Make this contact type the primary contact. Will make all other contact details of the same type no longer primary.

  • account_uuids array[string] Required

    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

  • 201 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
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":["f68a170a-3823-43ae-8892-d29d11602604","7ba75c11-4806-4a2e-83e8-a4e97653bf74"],"primary_account_uuids":["5ab3557c-e891-4b38-82b9-9595eca85b20","c5a781c4-ad01-41df-be12-9d6ae131cec2"]}'
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": [
    "f68a170a-3823-43ae-8892-d29d11602604",
    "7ba75c11-4806-4a2e-83e8-a4e97653bf74"
  ],
  "primary_account_uuids": [
    "5ab3557c-e891-4b38-82b9-9595eca85b20",
    "c5a781c4-ad01-41df-be12-9d6ae131cec2"
  ]
}
Response examples (201) 
{
  "name": "Work number",
  "type": "phone_number",
  "uuid": "5eb33380-d695-4d89-b8c5-9a0fe49334df",
  "value": "+443330903630",
  "accounts": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "5cd1294f-a933-4b1f-9e2c-154e0ec4b7ca",
    "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-12-04T22:09:17+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-12-04T22:09:17+00:00",
    "with_login": true,
    "inactive_at": "2025-12-04",
    "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-12-04T22:09:17+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-12-04T22:09:17+00: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-12-04T22:09:17+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-12-04T22:09:17+00:00"
  },
  "created_at": "2025-12-04T22:09:17+00:00",
  "updated_at": "2025-12-04T22:09:17+00:00",
  "phone_number_meta": {
    "country": "GB",
    "formatted": "0333 090 3630"
  }
}