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

Headers

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

Body

  • type string Required

    Contact Detail type.

    Value Description
    email Email
    phone_number Phone Number

    Values are email or phone_number.

  • is_primary boolean

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

  • name string Required

    Description of contact detail

    Maximum length is 255.

  • value string(international phone) | string(UK phone) | object | string(email) Required

    Contact Detail value can be provided in various formats. Phone number or email address depending on the type.

    One of:
    string-1 string(international phone) string-2 string(UK phone) object-3 object string-4 string(email)

    Phone number in international format

    Phone number in UK standard format

    Email address

  • account_uuids array[string(uuid)] Required

    The UUIDs of the accounts who should own the contact detail. These must only be client accounts.

  • primary_account_uuids array[string(uuid)]

    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
      • last_interaction_at string
      • referral_code 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":"email","is_primary":true,"name":"Work phone number","value":"+44751488454","account_uuids":["8c0a96e0-6724-40fb-a4a1-0abe09ed4de9","8363761b-97a6-441f-b047-dac2de31bd64","3a51fd5c-19a0-44a7-b017-dfa0ba39f963"],"primary_account_uuids":["6fabe226-610d-479c-9755-e492759eafce","6df7860d-e8be-4e28-b982-5b1971a9bcbf","a33ea843-2252-43ea-bac6-a813c7091d48"]}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "type": "email",
  "is_primary": true,
  "name": "Work phone number",
  "value": "+44751488454",
  "account_uuids": [
    "8c0a96e0-6724-40fb-a4a1-0abe09ed4de9",
    "8363761b-97a6-441f-b047-dac2de31bd64",
    "3a51fd5c-19a0-44a7-b017-dfa0ba39f963"
  ],
  "primary_account_uuids": [
    "6fabe226-610d-479c-9755-e492759eafce",
    "6df7860d-e8be-4e28-b982-5b1971a9bcbf",
    "a33ea843-2252-43ea-bac6-a813c7091d48"
  ]
}
Response examples (201) 
{
  "name": "Work number",
  "type": "phone_number",
  "uuid": "92eb1ee3-5d7b-411b-a69b-af288cfb5d4f",
  "value": "+443330903630",
  "accounts": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "f6a668f4-7d3c-4e3d-88c0-91037cf6ef01",
    "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": "2026-02-06T09:09:45+00:00",
    "first_name": "Gareth",
    "updated_at": "2026-02-06T09:09:45+00:00",
    "with_login": true,
    "inactive_at": "2026-02-06",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "referral_code": "ABC12345",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2026-02-06T09:09:45+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2026-02-06T09:09:45+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "last_interaction_at": "2026-02-06 09:09:45",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2026-02-06T09:09:45+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2026-02-06T09:09:45+00:00"
  },
  "created_at": "2026-02-06T09:09:45+00:00",
  "updated_at": "2026-02-06T09:09:45+00:00",
  "phone_number_meta": {
    "country": "GB",
    "formatted": "0333 090 3630"
  }
}