Account

The account model represents the overarching entity which "owns" all data, such as forms, users or responses.


Account fields

Field Type Fillable Reference
address   Array Yes
auto_delete_contact_days   Integer Yes
balance   Integer
call_limit   Integer
call_sender_id   Integer Yes
color   Color Yes
A HEX value used to theme interfaces with the organisation brand color.
config   Object
contact_matching_requirement   String Yes
contact_sort_direction   String Yes
contact_sort_field_id   Integer Yes
contrast_color   String
created_at   Timestamp
The date the account was created.
currency   String
currency_symbol   String
debug_mode   Boolean
default_attendance_added_status   Integer Yes
default_attendance_captured_status   Integer Yes
default_country   String Yes
deleted_at   Timestamp
The date the account was deleted.
header_bg   URL
A URL to an image of the organisation's header background for use in apps, this should be an https URL to prevent security warnings in some browsers.
header_logo   URL
A URL to an image of the organisation's header logo for use in apps, this should be an https URL to prevent security warnings in some browsers.
id   Integer
The unique ID to identify the account
logo   URL
A URL to an image of the organisation's logo, this should be an https URL to prevent security warnings in some browsers.
long_date_format   String
name   String Required
This will usually be the name of the organisation who use the account.
organisation_sort_direction   String Yes
organisation_sort_field_id   Integer Yes
owner_id   Reference Required User
Indicates which user is the owner of the account.
package_id   Reference Package
Indicates which package the account is on.
privacy_policy   String Yes
rebrand_id   Reference Rebrand
Indicates which rebrand the account is associated with.
region   String
ringtone   String Yes
ringtone_url   String
sender_id   Reference Yes Sender
Specifies the sender which is used by default when sending emails.
short_date_format   String Yes
short_name   String Yes
sms_sender_id   Integer Yes
timezone   String Required
updated_at   Timestamp
The date the account was last updated.
uuid   String

Account relations

call_sender, package, sender, sms_sender, logo_file, header_bg_file, header_logo_file,

Account endpoints

GET Return data for a specified Account. /accounts/:id toggle

POST Update the Account /accounts/:id toggle

POST Register a new account /accounts/register toggle