Update a login
Headers
-
Content-Type string
-
Accept string
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.
-
Give this login write access for the account. False to leave as read only.
-
Give this access to delete items. False to prevent logins from deleting resources.
-
Set to true this login be able to access wealth on the client portal.
-
Set to true for this login to be able to access goals on the client portal.
-
Set to true for this login to be able to access fact-finds on the client portal.
-
Set to true for this login to be able to access tasks on the client portal.
-
Set to true for this login to have various welcome page elements.
-
Set to true this login should receive the unread notification digest email
PUT
/api/v1/account/{account_uuid}/login/{uuid}
curl \
--request PUT https://api.plannrcrm.com/api/v1/account/account_uuid/login/uuid \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data '{"expires_at":"2025-02-07T15:04:39+00: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": "2025-02-07T15:04:39+00: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": "f31888f8-0bec-4105-acb1-b2fe8091709d",
"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": "2025-02-04T15:04:39+00:00",
"updated_at": "2025-02-04T15:04:39+00: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": "93d0bf98-0468-4cfa-ad6d-994c68f9809f",
"email": "gareth@plannrcrm.com",
"account": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "ffff2dee-b173-421d-aa69-8ae996657ad0",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-02-04T15:04:39+00:00",
"first_name": "Gareth",
"updated_at": "2025-02-04T15:04:39+00: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": "2025-02-04T15:04:39+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-02-04T15:04:39+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2025-02-04T15:04:39+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-02-04T15:04:39+00:00"
},
"primary": false,
"last_name": "Thompson",
"created_at": "2025-02-04T15:04:39+00:00",
"expires_at": "2025-05-15T15:04:39+01:00",
"first_name": "Gareth",
"updated_at": "2025-02-04T15:04:39+00: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
}