The details for the person to add.
The response body if response status OK, or response body of validation errors if response status 400.
Delete a specific person in the Outseta CRM by their uid.
const client = new OutsetaApiClient({
subdomain: 'test-company',
apiKey: example_key,
secretKey: example_secret
});
const response = await client.crm.people.delete(uid);
console.log(response);
The uid for the person to delete.
Null if deletion was successful.
Get a specific person in the Outseta CRM by their uid.
const client = new OutsetaApiClient({
subdomain: 'test-company',
apiKey: example_key,
secretKey: example_secret
});
const response = await client.crm.people.get(uid);
console.log(response);
The uid for the person to get.
The response body if response status OK.
Get all people in the Outseta CRM.
const client = new OutsetaApiClient({
subdomain: 'test-company',
apiKey: example_key,
secretKey: example_secret
});
const response = await client.crm.people.getAll();
console.log(response);
The number of results returned by the API.
For pagination; returns (limit) results after this value.
The response body if response status OK.
Update a person in the CRM. Must include their uid.
const client = new OutsetaApiClient({
subdomain: 'test-company',
apiKey: example_key,
secretKey: example_secret
});
const response = await client.crm.people.update({
Uid: 'DQ2DyknW',
Email: 'hello@tiltcamp.com'
});
console.log(response);
The profile fields and values to update. Must include the user's uid.
The response body if response status OK, or response body with validation errors if response status 400.
Generated using TypeDoc
Add a person to the CRM. Must include an email address.
Response If the server returns a non-"OK" or non-"400" status, the whole response object will be thrown.