Key Accounts
Key Accounts Documentation
Key Account [LIST]
Key Account [LIST]
Request
Endpoint
Body
Response
Headers
Body
Fields
data
Type
[Key Account]
Description An array of Key Accounts
Key Account [POST]
Key Account [POST]
Request
Endpoint
Body
Parameters
Attributes
created_at
Type
date
Description The timestamp of when this resource was created
Required No
Type
string
Description Email
Required No
first_name
Type
string
Description First Name
Required No
last_download
Type
string
Description Last Download
Required No
last_name
Type
string
Description Last Name
Required No
primary
Type
boolean
Description Primary
Required No
remote_id
Type
number
Description Key Account SSO GUID
Required No
updated_at
Type
date
Description The timestamp of when this resource was last updated
Required No
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Required No
Response
Headers
Body
Fields
Attributes
created_at
Type
date
Description The timestamp of when this resource was created
Type
string
Description Email
first_name
Type
string
Description First Name
last_download
Type
string
Description Last Download
last_name
Type
string
Description Last Name
primary
Type
boolean
Description Primary
remote_id
Type
number
Description Key Account SSO GUID
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Key Account [GET]
Key Account [GET]
Request
Endpoint
Body
Response
Headers
Body
Fields
Attributes
created_at
Type
date
Description The timestamp of when this resource was created
Type
string
Description Email
first_name
Type
string
Description First Name
last_download
Type
string
Description Last Download
last_name
Type
string
Description Last Name
primary
Type
boolean
Description Primary
remote_id
Type
number
Description Key Account SSO GUID
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Key Account [PUT]
Key Account [PUT]
Request
Endpoint
Body
Parameters
Attributes
created_at
Type
date
Description The timestamp of when this resource was created
Required No
Type
string
Description Email
Required No
first_name
Type
string
Description First Name
Required No
last_download
Type
string
Description Last Download
Required No
last_name
Type
string
Description Last Name
Required No
overwrite
Type
boolean
Description
Only used for updating a record where you want to ignore the server's ' 'updated_in_db_at value and force overwrite the values for the record. ' 'Must be true to work.
Required No
primary
Type
boolean
Description Primary
Required No
remote_id
Type
number
Description Key Account SSO GUID
Required No
updated_at
Type
date
Description The timestamp of when this resource was last updated
Required No
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Required No
Response
Headers
Body
Fields
Attributes
created_at
Type
date
Description The timestamp of when this resource was created
Type
string
Description Email
first_name
Type
string
Description First Name
last_download
Type
string
Description Last Download
last_name
Type
string
Description Last Name
primary
Type
boolean
Description Primary
remote_id
Type
number
Description Key Account SSO GUID
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Last updated