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":["6548f3ed-fb8d-410b-a1ff-c9a96a94a102","f7d090ee-3b51-400a-91e7-87e9502c2cd4","534c277a-ca27-4c30-b146-c8b4d9fe2631"],"primary_account_uuids":["f148aef7-7ac5-4aae-a174-bb56bbbaac55","3facf146-0a46-4fcc-afd5-edc5a3e2fbc2","8dc0f608-2f0c-4902-81ca-5b539a35b063"]}'
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": [
    "6548f3ed-fb8d-410b-a1ff-c9a96a94a102",
    "f7d090ee-3b51-400a-91e7-87e9502c2cd4",
    "534c277a-ca27-4c30-b146-c8b4d9fe2631"
  ],
  "primary_account_uuids": [
    "f148aef7-7ac5-4aae-a174-bb56bbbaac55",
    "3facf146-0a46-4fcc-afd5-edc5a3e2fbc2",
    "8dc0f608-2f0c-4902-81ca-5b539a35b063"
  ]
}
Response examples (201) 
+443330903630