Go to Sisu
All Collections
Release Notes
API Release Notes

API Release Notes

This article contains all the new API-related features and bug fixes for 2022.
Alex Masterson avatar
Written by Alex Masterson
Updated this week

2022 Feature Releases:

December 1

New Features

There are no new API features this week.

Bug Fixes

There are no bug fixes this week.

November 16

New Features

There are no new API features this week.

Bug Fixes

There are no bug fixes this week.

November 2

New SET Method for Setting Your Team Theme

We've added a SET method for setting the team theme.

October 19

New Features

There are no new API features this week.

Bug Fixes

There are no bug fixes this week.

October 5

New Features

There are no new API features this week.

Bug Fixes

There are no bug fixes this week.

September 21

New Features

There are no new API features this week.

Bug Fixes

There are no bug fixes this week.

September 7

New Feature: We've Published Transaction Stage API Documentation

We've added the endpoints for Transaction Stage API to our documentation. You can find these endpoints here: https://docs.sisu.co/reference/post_api-v1-client-stages.

Bug Fixes

There are no bug fixes this week.

August 24

New features in this release:

ReadMe Authentication

Our Sisu API docs will now require sign-in. This allows us to auto-generate the API keys and populate them into the ReadMe documentation for ease of testing! You will also have your team_id and agent_id pre-filled automatically in endpoints that use them.

New Endpoints for Create, Update, and Delete Lost Reason

Previously we only had functionality to GET lost reasons. We have added the ability to Create, Update, and Delete.

New Endpoints added:

  • CREATE Lost Reasons (POST)

    • POST will just take in a reason and will automatically create the reason_id.

  • UPDATE Lost Reasons (PUT)

    • PUT will take a reason_id in the URL and a reason in the body.

  • DELETE Lost Reasons

    • DELETE will just take the reason_id in the URL.

Go to https://docs.sisu.co/reference/post_api-v1-archive-reasons for official API documentation.

Now You Can Set History Change Source for Your Integration

You can now include a parameter in your auth header and it will set the “Change Source” value in our History section. This value should be used to denote the name of a specific integration (often the name of the partner software that you are integrating with Sisu), rather than just a general company name where possible. Feel free to include a company name in addition to your integration name if desired.

  • Example: “Follow Up Boss - ABC Integrations Company”.

Simply include an “integration_name” header with a value equal to the name of your integration. A header of “integration_name: BoomTown” in an API call will set the Change Source to “Integration: BoomTown”.

  • Example:

Bug Fixes

There are no bug fixes this week.

August 10

New Feature: We've Updated 2 GET Endpoints

We've updated the following endpoints:

  • GET api/v1/organization-info

    • We've stripped all “null” or empty string attributes in the return dict. See common.scrub_dict().

  • GET api/v1/team/get-team-agents/{team_id}

    • We've included all external_ids and used the existing SQLAlchemy external_ids relationship and a joinedload() to JOIN the IDs in on the agent query.

    • We've stripped all “null” or empty string attributes in the return dict. See common.scrub_dict().

July 20

New Features

There are no new API features this week.

Bug Fixes

There are no bug fixes this week.

July 7

New Features

There are no new API features this week.

Bug Fixes

There are no bug fixes this week.

June 22

New Features

There are no new API features this week.

Bug Fixes

There are no bug fixes this week.

June 8

New Features

There are no new API features this week.

Bug Fixes

There are no bug fixes this week.

May 26

New Features

There are no new API features this week.

Bug Fixes

There are no bug fixes this week.

May 9

New features in this release:

Post Comments to a Specific Document

API users can now post comments to a specific document. The API will now take the following into account:

  • agent_id integer

    • agent ID

  • client_id integer

    • ID of the transaction

  • document_id integer

    • ID of the specific document that needs a comment

  • comment_value string

    • The comment they’re wanting to leave

  • comment_display_name string

    • The ability to set WHO or WHERE the comment came from

Post Comments to a Specific Transaction

API users can now post comments to a specific transaction. The API will now take the following into account:

  • agent_id integer

    • agent ID

  • client_id integer

    • ID of the transaction

  • comment_value string

    • The comment they’re wanting to leave

  • comment_display_name string

    • The ability to set WHO or WHERE the comment came from

April 27

New Features

There are no new API features this week.

Bug Fixes

There are no bug fixes this week.

April 13

New Feature: Now You Can Remove Tasks When Deleting a Transaction

As a user of the API, you have the ability to archive a transaction, set it as Lost, and include a reason; however, you don’t have the ability to remove associated tasks. You can now include remove_task=true in the DELETE client request, and it will remove any tasks associated with it.

EXAMPLE: DELETE {{url}}/api/{{version}}client/edit-client/123456?agent_id=842353&remove_task=true&reason_id=16789

Bug Fixes

Each bug fix in this section includes relevant ticket numbers.

  • We fixed an error that was occurring when searching for the Get agents API endpoint "all." (4320)

March 23

New Features

There are no new API features this week.

Bug Fixes

Each bug fix in this section includes relevant ticket numbers.

  • We fixed an issue where agents could not be found based on an email search. (4323)

  • We fixed an issue where agents weren't being returned when someone was trying to use the API to get agents. (4319)

March 9

Features in this release:

For a list of bug fixes, click here.

Now You Can Get Specific Contact Transactions

Perform an API call to /contact/{contact_id}/transactions and it should now return ALL transactions associated.

Get the Reason for a Lost Transaction

We've added the ability to include the lost reason (reason_id) in the API update. To get a team's reason_id, send a request to [GET] /api/v1/archive-reasons/{agent_id}.

Transaction Status Added to 2 Webhook Responses

We've added pipeline_status to the webhook response for Client and Agent endpoints.

Bug Fixes

Each bug fix in this section includes relevant ticket numbers.

  • We fixed an issue where the client find-edit was returning the error of "more than one client." (4092)

February 25

NEW FEATURE: When Agent Data Is Returned, You'll Know If It's an ISA or Not

We’re including an “is_ISA” TRUE or FALSE with all agent payload data so you'll know if the returned agent was an ISA. All agent-related endpoints have been modified.

February 10

UPDATED FUNCTIONALITY: Adds a "Features" List to Return Misc Add-ons

Adds a "features" list to the GET team info endpoint. These feature flags are for the Premier and Misc Add-on options (see screenshot below) for a Sisu team account.

Example

GET: api/v1/team/info

"features": {

"boomtown": true,

"bulk_delete": false,

"cinc": false,

"daily_challenges": false,

"geo": false,

"kwmaps": false,

"rtc": false,

"sisu": false,

"skyslope": true,

"skyslope_forms": false,

"slack": true,

"tasks": true,

"trans_merge": false,

"vendor_invites": false,

"zillow": true

BUG FIXES

Each bug fix in this section includes relevant ticket numbers.

  • We fixed an issue where the API was allowing more agents to be created than there were licenses. This update will ensure that the license count is checked when creating new agents via the API. (3982)

January 26

Features in this release:

For a list of bug fixes, click here.

NEW FEATURE: The welcome email will send now when adding a new agent

Currently, the Create new agent via the API won’t initiate the welcome email. This enhancement will make that possible by including

"send_email"=True.

endpoint updated: POST -> /api/v1/agent/edit-agent/<int:team_id>

NEW FEATURE: We're adding pipeline_status to GET response for Client & Agent endpoints

In 3 of our endpoints, we're now returning an attribute called "pipeline_status" which directly relates to the Transaction STATUS value! This is only available in a GET response and not editable via API. The value is derived from the dates set on the transaction. To find out which dates need to be completed to get that status to change, you can review this KB article.

UPDATED FUNCTIONALITY: API Documentation Has Moved

We’ve moved our API endpoints and any other API-related documentation to a new site: https://docs.sisu.co/docs.

BUG FIXES

Each bug fix in this section includes relevant ticket numbers.

  • We fixed an issue where removing tags from a client also deleted the entire client. (3849)

  • We fixed an issue where the API response for finding an agent was returning NULL for the team_id even when the agent was currently on a team. (3692)

Did this answer your question?