⚑
Other integrations
πŸ’Ÿ
Account health scores & metrics
Accounts

The Account object

Attributes
Description
Editable?
id
Vitally's unique ID for the account
No
createdAt
Datetime the account was created
No
updatedAt
Datetime the account was last updated
No
externalId
​Your unique ID for the account
Only on create
name
Name of the account
Yes
traits
Set of key-value pairs to attach to the account
Yes
accountOwnerId
Vitally ID for the User that is the account owner
No
churnedAt
Datetime the account churned
Via traits
firstSeenTimestamp
Datetime the account was first active in your product
No
lastSeenTimestamp
Datetime the account was last active in your product
No
lastInboundMessageTimestamp
Datetime a user at the account last sent your team a message
No
lastOutboundMessageTimestamp
Datetime someone on your team last sent the account a message
No
mrr
Monthly recurring revenue for the account
Via traits
nextRenewalDate
Datetime the account is next set to renew their subscription
Via traits
trialEndDate
Datetime the account's trial is set to end
Via traits
usersCount
The number of users at the account
No
npsDetractorCount
The number of users at the account with a last NPS score <= 6
No
npsPassiveCount
The number of users at the account with a last NPS score of 7 or 8
No
npsPromoterCount
The number of users at the account with a last NPS score of 9 or 10
No
npsScore
The NPS score for the account across all its users (-100 to 100)
No
healthScore
The account's current health score (0-10)
No
csmId
Vitally ID for the team member that is the account's CSM
No
accountExecutiveId
Vitally ID for the team member that is the account's account executive
No
segments
Array of segments (id,name)
In-app

List Accounts GET

1
https://rest.vitally.io/resources/accounts
Copied!
Paginated list of Accounts, by default ordered by updatedAt.
Params (see Pagination)
Example Request
1
GET https://rest.vitally.io/resources/accounts?limit=10&from=cursor
Copied!
Example Response
1
{
2
"results": [...],
3
"next": "c29tZWJhc2U2NA=="
4
}
Copied!

Get An Account GET

1
https://rest.vitally.io/resources/accounts/:id
Copied!
Request Params
Property
Type
Description
id
string
Accepts both the Account ID assigned by Vitally and the externalId if provided when creating the Account
Example
1
GET https://rest.vitally.io/resources/accounts/:id
2
GET https://rest.vitally.io/resources/accounts/:externalId
Copied!

Create An Account POST

1
https://rest.vitally.io/resources/accounts
Copied!
Request Body
Property
Type
Description
externalId
string
Required The unique ID of this Account in your system
name
string
The name of the Account
traits
object
A JSON object containing the traits of this Account.
Example
1
POST https://rest.vitally.io/resources/accounts
2
{
3
"externalId": "account-101",
4
"name": "Big Corp",
5
"traits": {
6
"paymentMethod": "subscription",
7
...
8
}
9
}
Copied!

Update An Account PUT

1
https://rest.vitally.io/resources/accounts/:id
Copied!
Request Params
Property
Type
Description
id
string
Accepts both the Account ID assigned by Vitally and the externalId if provided when creating the Account
Request Body
Property
Type
Description
name
string
The name of the Account
traits
object
A JSON object containing the traits of this Account. Note that traits specified here are merged with the account's existing traits. Any trait not specified is not removed.
To remove a trait from an account, set the trait to null in the traits object.
Example
1
PUT https://rest.vitally.io/resources/accounts/:id
2
{
3
"name": "New Name",
4
"traits": {
5
"existingTrait": "new value",
6
"newTrait": 100,
7
...
8
}
9
}
Copied!

Delete An Account DELETE

1
https://rest.vitally.io/resources/accounts/:id
Copied!
Request Params
Property
Type
Description
id
string
Accepts both the Account ID assigned by Vitally and the externalId if provided when creating the Account
Last modified 5mo ago