Update a login

PUT /api/v1/account/{account_uuid}/login/{uuid}

application/json

Body Required

expires_at string

Timestamp of how long this login is valid for temporary access. Can leave blank for no expiration.
primary string

Make this the primary login for this account. Only one primary login per account.
has_write_permission boolean Required

Give this login write access for the account. False to leave as read only.
has_delete_permission string Required

Give this access to delete items. False to prevent logins from deleting resources.
wealth_enabled boolean Required

Set to true this login be able to access wealth on the client portal.
goals_enabled boolean Required

Set to true for this login to be able to access goals on the client portal.
factfind_enabled boolean Required

Set to true for this login to be able to access fact-finds on the client portal.
tasks_enabled boolean Required

Set to true for this login to be able to access tasks on the client portal.
welcome_enabled boolean Required

Set to true for this login to have various welcome page elements.
receives_unread_notifications_email boolean

Set to true this login should receive the unread notification digest email

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.
- expires_at string
  
  Timestamp for when the login is set to expire.
- has_write_permission boolean
  
  Denotes if the login has access to modify records.
- has_delete_permission boolean
  
  Denotes if the login has access delete records.
- primary boolean
  
  Denotes if the login is the primary login for the account.
- receives_unread_notifications_email boolean
  
  If the login for the account will receive the unred notification emails
- wealth_enabled boolean
  
  If the login for the account will have access to wealth on the client portal.
- goals_enabled boolean
  
  If the login for the account will have access to goals.
- factfind_enabled boolean
  
  If the login for the account will have access to fact-finds.
- tasks_enabled boolean
  
  If the login for the account will have access to tasks.
- welcome_enabled boolean
  
  If the login for the account will have various welcome branding elements.
- first_name string
  
  First name of the user.
- last_name string
  
  Last name of the user.
- email string
  
  Email of the user.
- account object
  
  The account the login is for.
- firm object
  
  The firm the login is for.
- is_impersonated boolean
  
  Denotes if the login was created by Plannr Support as an impersonation login.

PUT /api/v1/account/{account_uuid}/login/{uuid}

curl \
 -X PUT https://api.plannrcrm.com/api/v1/account/account_uuid/login/uuid \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"expires_at":"2024-10-19T11:10:13+01:00","primary":true,"has_write_permission":true,"has_delete_permission":"1","wealth_enabled":true,"goals_enabled":true,"factfind_enabled":true,"tasks_enabled":true,"welcome_enabled":true,"receives_unread_notifications_email":true}'

Request examples

# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "expires_at": "2024-10-19T11:10:13+01:00",
  "primary": true,
  "has_write_permission": true,
  "has_delete_permission": "1",
  "wealth_enabled": true,
  "goals_enabled": true,
  "factfind_enabled": true,
  "tasks_enabled": true,
  "welcome_enabled": true,
  "receives_unread_notifications_email": true
}

Response examples (200)

{
  "firm": {
    "tax": 17.5,
    "logo": "https://api.plannrcrm.com/images/plannr.jpg",
    "name": "Codepotato",
    "slug": "codepotato",
    "uuid": "15460e5d-f777-42ad-8bfb-26cbf622b229",
    "county": "Hampshire",
    "billing": {
      "invoice_email": "gareth@codepotato.co.uk",
      "invoice_county": "Hampshire",
      "invoice_country": "United Kingdom",
      "invoice_postcode": "PO7 7YH",
      "invoice_address_1": "Suite E, 5 The Briars",
      "invoice_address_2": "Waterberry Drive",
      "invoice_town_city": "Waterlooville"
    },
    "country": "United Kingdom",
    "postcode": "PO7 7YH",
    "address_1": "Suite E, 5 The Briars",
    "address_2": "Waterberry Drive",
    "logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
    "month_end": 25,
    "town_city": "Waterlooville",
    "created_at": "2024-10-16T11:10:13+01:00",
    "updated_at": "2024-10-16T11:10:13+01:00",
    "ip_whitelist": [
      "192.168.0.1",
      "127.0.0.1"
    ],
    "brand_colours": {
      "sidebar_text": "#ffffff",
      "sidebar_hover": "#0A0A42",
      "email_sub_text": "#ffffff",
      "sidebar_accent": "#36367E",
      "sidebar_active": "#53DBB8",
      "email_background": "#0E0E56",
      "email_button_text": "#ffffff",
      "sidebar_background": "#0E0E56",
      "sidebar_title_primary": "#FFC634",
      "email_button_background": "#36367E",
      "sidebar_title_secondary": "#ffffff",
      "sidebar_title_background": "#36367E",
      "email_logo_background_panel": "#36367E",
      "sidebar_title_secondary_hover": "#ffffff"
    },
    "is_subscribed": true,
    "regulatory_text": "Regulatory text",
    "addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
    "statement_frequency": "monthly",
    "task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
    "keep_deleted_files_for": 30,
    "welcome_paragraph_html": "<h1>Welcome.</h1>",
    "email_welcome_paragraph_html": "Welcome to Plannr!"
  },
  "uuid": "c0b5ae22-57e7-427e-bc89-b9bf89b7ecee",
  "email": "gareth@plannrcrm.com",
  "account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "67cf0fc8-f4c8-494d-8864-6090c2cf1785",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:13+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:13+01:00",
    "with_login": true,
    "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": "2024-10-16T11:10:13+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:13+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:13+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:13+01:00"
  },
  "primary": false,
  "last_name": "Thompson",
  "created_at": "2024-10-16T11:10:13+01:00",
  "expires_at": "2025-01-24T11:10:13+00:00",
  "first_name": "Gareth",
  "updated_at": "2024-10-16T11:10:13+01:00",
  "goals_enabled": true,
  "tasks_enabled": true,
  "wealth_enabled": true,
  "is_impersonated": false,
  "welcome_enabled": true,
  "factfind_enabled": true,
  "has_write_permission": false,
  "has_delete_permission": false,
  "receives_unread_notifications_email": true
}

Update a login

Headers

Path parameters

Body Required

Responses