The details for the account to add.
Not all fields on the model are returned by default - you can request specific fields with a that looks something like ',PersonAccount.,PersonAccount.Person.Uid'. Note: the shape of the returned object may not match the model in this library if this string does not start with '*' as shown.
The response body if response status OK, or response body with validation errors if response status 400.
Cancel a subscribed account.
const client = new OutsetaApiClient({
subdomain: 'test-company',
apiKey: example_key,
secretKey: example_secret
});
const response = await client.crm.accounts.cancel({
CancelationReason: 'I am cancelling because ...',
Comment: 'Insert comments here',
Account: {
Uid: 'BWz87NQE'
}
});
console.log(response);
The cancellation object. Must include the account's uid.
Null if response status OK, or response body with validation errors if response status 400.
Delete a specific account in the Outseta CRM by its uid.
const client = new OutsetaApiClient({
subdomain: 'test-company',
apiKey: example_key,
secretKey: example_secret
});
const response = await client.crm.accounts.cancel(uid);
console.log(response);
The uid for the account to delete.
Null if deletion was successful.
Immediately cancel an account's subscription by "expiring" it now.
const client = new OutsetaApiClient({
subdomain: 'test-company',
apiKey: example_key,
secretKey: example_secret
});
const response = await client.crm.accounts.expireCurrentSubscription(uid);
console.log(response);
The uid for the account to expire.
Null if deletion was successful, or response body of validation errors if response status 400.
Set the trial expiration to a particular date. Meant for extension, but seems to also work for shortening a trial period.
const client = new OutsetaApiClient({
subdomain: 'test-company',
apiKey: example_key,
secretKey: example_secret
});
const response = await client.crm.accounts.extendTrial(uid, new Date('01/01/2021'));
console.log(response);
The uid for the account to edit.
The date to set the trial expiration to.
Null if deletion was successful, or response body of validation errors if response status 400.
Get a specific account in the Outseta CRM by its uid.
const client = new OutsetaApiClient({
subdomain: 'test-company',
apiKey: example_key,
secretKey: example_secret
});
const response = await client.crm.accounts.get(uid);
console.log(response);
The uid for the account to get.
Not all fields on the model are returned by default - you can request specific fields with a that looks something like ',PersonAccount.,PersonAccount.Person.Uid'. Note: the shape of the returned object may not match the model in this library if this string does not start with '*' as shown.
The response body.
Get all accounts in the Outseta CRM.
const client = new OutsetaApiClient({
subdomain: 'test-company',
apiKey: example_key,
secretKey: example_secret
});
const response = await client.crm.accounts.getAll();
console.log(response);
Filter the results to only users in this account stage.
Not all fields on the model are returned by default - you can request specific fields with a that looks something like ',PersonAccount.,PersonAccount.Person.Uid'. Note: the shape of the returned object may not match the model in this library if this string does not start with '*' as shown.
The number of results returned by the API.
For pagination; returns (limit) results after this value.
The response body.
Removes the "cancellation" flag from an account with a subscription that is scheduled to expire.
const client = new OutsetaApiClient({
subdomain: 'test-company',
apiKey: example_key,
secretKey: example_secret
});
const response = await client.crm.accounts.removeCancellation(uid);
console.log(response);
The uid for the account to "uncancel".
Null if deletion was successful, or response body of validation errors if response status 400.
Update an account in the CRM. Must include its uid.
const client = new OutsetaApiClient({
subdomain: 'test-company',
apiKey: example_key,
secretKey: example_secret
});
const response = await client.crm.accounts.update({
Uid: 'DQ2DyknW',
Name: 'New Name for TiltCamp'
});
console.log(response);
The account fields and values to update. Must include the account's uid.
Not all fields on the model are returned by default - you can request specific fields with a that looks something like ',PersonAccount.,PersonAccount.Person.Uid'. Note: the shape of the returned object may not match the model in this library if this string does not start with '*' as shown.
The response body if response status OK, or response body with validation errors if response status 400.
Generated using TypeDoc
Add an account to the CRM. Must include a name.
For adding a new person with the account:
For adding an existing person with the account:
Response If the server returns a non-"OK" status, the whole response object will be thrown.