Skip to content

Account Information

Paride Azzari edited this page Aug 24, 2024 · 1 revision

Account Info

These entry points allow you to retrieve or update your account information, like your business address, branding information, and other information.

Info

The method info will return an array the information relative to the current business.

use KeapGeek\Keap\Facades\Keap;

Keap::account()->info();

It will return an array with the following information and values

[
    "address" => [
        "country_code" => string,
        "field" => "BILLING",
        "line1" => string,
        "line2" => string,
        "locality" => string,
        "postal_code" => string,
        "region" => string,
        "zip_code" => string,
        "zip_four" => string
    ],
    "business_goals" => [string],
    "business_primary_color" => string,
    "business_secondary_color" => string,
    "business_type" => string,
    "currency_code" => string,
    "email" => string,
    "language_tag" => string,
    "logo_url" => string,
    "name" => string,
    "phone" => string,
    "phone_ext" => string,
    "time_zone" => string,
    "website" => string
]

Update

use KeapGeek\Keap\Facades\Keap;

Keap::account()->update(['key' => 'value']);

All the previous items can be modified by calling the update method. There is not a strong validation from Keap server, therefore make sure to have the correct values before sending the API call.

In case of wrong key values, the server will return a Bad Request Exception, that is catched by Laravel Keap and will display the error message with the wrong key, if in debug mode.

This last command returns again the whole array, with the modified values.

Clone this wiki locally