SmallBizCRM API Docs - Auth, Webhooks, SDKs for Developers

Accounts

Get a single account by ID

GET

accounts/{accountId}

Accounts

Create a new account

POST

accounts

accountName, accountNumber, address, city, country, fax, industry, locale, name, notes, numberOfEmployees, owner, parentAccount, phone, rating, state, street, symbol, tickerSymbol, website, yearEstablished

Accounts

Update a single account

PUT

accounts/{accountId}

accountName, accountNumber, address, city, country, fax, industry, locale, name, notes, numberOfEmployees, owner, parentAccount, phone, rating, state, street, symbol, tickerSymbol, website, yearEstablished

Accounts

Update a specific field or fields of the account

accounts/{accountId}

accountName, accountNumber, address, city, country, fax, industry, locale, name, notes, numberOfEmployees, owner, parentAccount, phone, rating, state, street, symbol, tickerSymbol, website, yearEstablished

Accounts

Delete a single account by ID

DELETE

accounts/{accountId}

Activities

Get a single activity by ID

GET

activities/{activityId}

Activities

Create a new activity

POST

activities

activityDate, activityType, assignedUserId, duration, location, notes, priority, relatedObjectId, relatedObjectType, taskStatus

Activities

Update a single activity

PUT

activities/{activityId}

activityDate, activityType, assignedUserId, duration, location, notes, priority, relatedObjectId, relatedObjectType, taskStatus

Activities

Update a specific field or fields of the activity

activities/{activityId}

activityDate, activityType, assignedUserId, duration, location, notes, priority, relatedObjectId, relatedObjectType, taskStatus

Activities

Delete a single activity by ID

DELETE

activities/{activityId}

Attachments

Get a single attachment by ID

GET

attachments/{attachmentId}

Attachments

Create a new attachment

POST

attachments

fileName, mimeType, parentId, relatedObjectType

Attachments

Update a single attachment

PUT

attachments/{attachmentId}

fileName, mimeType, parentId, relatedObjectType

Attachments

Update a specific field or fields of the attachment

attachments/{attachmentId}

fileName, mimeType, parentId, relatedObjectType

Attachments

Delete a single attachment by ID

DELETE

attachments/{attachmentId}

Campaigns

Get a single campaign by ID

GET

campaigns/{campaignId}

Campaigns

Create a new campaign

POST

campaigns

campaignName, campaignType, startDate, endDate, status, expectedRevenue, description, assignedUserId, budgetCost, expectedResponse, numSent, openRate, clickRate, bounceRate, revenue, costPerConversion, notes

Campaigns

Update a single campaign

PUT

campaigns/{campaignId}

campaignName, campaignType, startDate, endDate, status, expectedRevenue, description, assignedUserId, budgetCost, expectedResponse, numSent, openRate, clickRate, bounceRate, revenue, costPerConversion, notes

Campaigns

Update a specific field or fields of the campaign

campaigns/{campaignId}

campaignName, campaignType, startDate, endDate, status, expectedRevenue, description, assignedUserId, budgetCost, expectedResponse, numSent, openRate, clickRate, bounceRate, revenue, costPerConversion, notes

Campaigns

Delete a single campaign by ID

DELETE

campaigns/{campaignId}

Cases

Get a single case by ID

GET

cases/{caseId}

Cases

Create a new case

POST

cases

caseNumber, accountId, contactId, type, subject, priority, status, description, origin, assignedUserId, resolution

Cases

Update a single case

PUT

cases/{caseId}

caseNumber, accountId, contactId, type, subject, priority, status, description, origin, assignedUserId, resolution

Cases

Update a specific field or fields of the case

cases/{caseId}

caseNumber, accountId, contactId, type, subject, priority, status, description, origin, assignedUserId, resolution

Cases

Delete a single case by ID

DELETE

cases/{caseId}

Contacts

Get a single contact by ID

GET

contacts/{contactId}

Contacts

Create a new contact

POST

contacts

firstName, lastName, accountId, jobTitle, department, email, phone, mobilePhone, fax, assistant, birthdate, leadSource, description, industry, locale, referredBy, leadStatus, annualRevenue, employees, assignedUserId, twitter, linkedin, facebook, googlePlus, skype

Contacts

Update a single contact

PUT

contacts/{contactId}

firstName, lastName, accountId, jobTitle, department, email, phone, mobilePhone, fax, assistant, birthdate, leadSource, description, industry, locale, referredBy, leadStatus, annualRevenue, employees, assignedUserId, twitter, linkedin, facebook, googlePlus, skype

Contacts

Update a specific field or fields of the contact

contacts/{contactId}

firstName, lastName, accountId, jobTitle, department, email, phone, mobilePhone, fax, assistant, birthdate, leadSource, description, industry, locale, referredBy, leadStatus, annualRevenue, employees, assignedUserId, twitter, linkedin, facebook, googlePlus, skype

Contacts

Delete a single contact by ID

DELETE

contacts/{contactId}

Contracts

Get a single contract by ID

GET

contracts/{contractId}

Contracts

Create a new contract

POST

contracts

contractName, accountId, contactId, startDate, endDate, value, status, description, assignedUserId, contractTerm, type, billingStreet, billingCity, billingState, billingCountry, billingPostalCode, billingAddress, shippingStreet, shippingCity, shippingState, shippingCountry, shippingPostalCode, shippingAddress, renewalDate, notes

Contracts

Update a single contract

PUT

contracts/{contractId}

contractName, accountId, contactId, startDate, endDate, value, status, description, assignedUserId, contractTerm, type, billingStreet, billingCity, billingState, billingCountry, billingPostalCode, billingAddress, shippingStreet, shippingCity, shippingState, shippingCountry, shippingPostalCode, shippingAddress, renewalDate, notes

Contracts

Update a specific field or fields of the contract

contracts/{contractId}

contractName, accountId, contactId, startDate, endDate, value, status, description, assignedUserId, contractTerm, type, billingStreet, billingCity, billingState, billingCountry, billingPostalCode, billingAddress, shippingStreet, shippingCity, shippingState, shippingCountry, shippingPostalCode, shippingAddress, renewalDate, notes

Contracts

Delete a single contract by ID

DELETE

contracts/{contractId}

Documents

Get a single document by ID

GET

documents/{documentId}

Documents

Create a new document

POST

documents

title, fileName, mimeType, fileSize, parentId, relatedObjectType

Documents

Update a single document

PUT

documents/{documentId}

title, fileName, mimeType, fileSize, parentId, relatedObjectType

Documents

Update a specific field or fields of the document

documents/{documentId}

title, fileName, mimeType, fileSize, parentId, relatedObjectType

Documents

Delete a single document by ID

DELETE

documents/{documentId}

Emails

Get a single email by ID

GET

emails/{emailId}

Emails

Create a new email

POST

emails

subject, sender, toRecipients, ccRecipients, bccRecipients, replyTo, bodyHtml, bodyText, internalDate, direction, important, flagged, draft, attachmentIds, relatedObjectId, relatedObjectType, emailDate, emailAccount, threadId

Emails

Update a single email

PUT

emails/{emailId}

subject, sender, toRecipients, ccRecipients, bccRecipients, replyTo, bodyHtml, bodyText, internalDate, direction, important, flagged, draft, attachmentIds, relatedObjectId, relatedObjectType, emailDate, emailAccount, threadId

Emails

Update a specific field or fields of the email

emails/{emailId}

subject, sender, toRecipients, ccRecipients, bccRecipients, replyTo, bodyHtml, bodyText, internalDate, direction, important, flagged, draft, attachmentIds, relatedObjectId, relatedObjectType, emailDate, emailAccount, threadId

Emails

Delete a single email by ID

DELETE

emails/{emailId}

Estimates

Get a single estimate by ID

GET

estimates/{estimateId}

Estimates

Create a new estimate

POST

estimates

estimateNumber, accountId, contactId, startDate, endDate, description, assignedUserId, discount, tax, subtotal, total, status, lineItems

Estimates

Update a single estimate

PUT

estimates/{estimateId}

estimateNumber, accountId, contactId, startDate, endDate, description, assignedUserId, discount, tax, subtotal, total, status, lineItems

Estimates

Update a specific field or fields of the estimate

estimates/{estimateId}

estimateNumber, accountId, contactId, startDate, endDate, description, assignedUserId, discount, tax, subtotal, total, status, lineItems

Estimates

Delete a single estimate by ID

DELETE

estimates/{estimateId}

Events

Get a single event by ID

GET

events/{eventId}

Events

Create a new event

POST

events

subject, startDate, endDate, recurrenceRule, description, location, organizer, attendees, reminder

Events

Update a single event

PUT

events/{eventId}

subject, startDate, endDate, recurrenceRule, description, location, organizer, attendees, reminder

Events

Update a specific field or fields of the event

events/{eventId}

subject, startDate, endDate, recurrenceRule, description, location, organizer, attendees, reminder

Events

Delete a single event by ID

DELETE

events

SmallBizCRM APIs

SmallBizCRM APIs

Details

Other Apps