Suggestion - Sunset REST v1 at the same time as XML-RPC

API Q&A
1

@OmarAlmonte - As per the title, as a suggestion you might as well sunset REST v1 at the same time as XML-RPC.

REST v2 is the successor to v1, so no other improvements are going to made to v1 now.
For developers, it should be easier to migrate from v1 to v2.

Come January 2027 you would just have the REST v2 API operating making it easier to deal with.

2

Hi Pav, we don’t have details on the retirement timing for REST v1 at this moment. We will communicate any decisions once they are finalized. In the meantime, as you suggested, we encourage integrators to use REST v2.

3

The biggest problem with sunsetting either XML-RPC and REST-v1 is that they each have functionality that is not supported in REST-v2 (at least, not when I last checked earlier this year). For the functionality in question, I believe I found threads in the forums that Keap had no intention to replicate all current functionality in REST-v2, which means XML-RPC/REST-v1 is the only option.

Here are a couple of quick examples where XML-RPC seems to be the only solution:

  • Add a TAG to a Company.
  • Remove a TAG from a Company.
  • Return list of all TAGs for a specific Company.

Here is an example of REST-v1 functionality not in REST-v2:

  • Retrieve all the TAGs for a specific Contact (e.g. List Applied Tags is available in REST-v1)

If there is functionality in REST-v2 to support these, I’d love to know how to do it. Maybe I’m missing something?

@OmarAlmonte , believe me, I’m happy to hear that Keap is talking about retiring the older API’s and potentially only having one API going forward. However, it needs to support all the functionality we currently have or else we (integrators) are going to be forced to use sub-optimal methods (e.g. making lots of API calls to replace the XML-RPC and REST-v1 functionality) to retrieve the data we need. I can provide more details if that would be helpful.

4

Thanks for laying this out, @Doug_Knudsen.

On the Company tag operations you mentioned, I’d like to understand a bit more about your current approach in XML-RPC. Could you share which specific method or workflow you’re using to add/remove tags or retrieve all tags for a Company?

Regarding your broader point, we’re absolutely open to hearing any specific functionality gaps you’re running into in v2. If there are areas where you’re unable to accomplish something directly today, feel free to share the details and we’ll be happy to look into it with the team

5

Hi @OmarAlmonte ,

Hopefully this is what you are looking for regarding the Company TAG actions:

<?xml version='1.0'?>
<methodCall>
<methodName>ContactService.addToGroup</methodName>
  <params>
	<param>
	  <value><string>dummyKey</string></value>
	</param>
	<param>
	  <value><int>{contactCompanyID}</int></value>
	</param>
	<param>
	  <value><int>{tagID}</int></value>
	</param>
  </params>
</methodCall>

<?xml version='1.0'?>
<methodCall>
<methodName>ContactService.removeFromGroup</methodName>
  <params>
	<param>
	  <value><string>dummyKey</string></value>
	</param>
	<param>
	  <value><int>{contactCompanyID}</int></value>
	</param>
	<param>
	  <value><int>{tagID}</int></value>
	</param>
  </params>
</methodCall>

<?xml version='1.0'?>
<methodCall>
  <methodName>DataService.load</methodName>
  <params>
	<param>
	  <value><string>dummyKey</string></value>
	</param>
	<param>
	  <value><string>Company</string></value>
	</param>
	<param>
	  <value><int>{companyID}</int></value>
	</param>
	<param>
	  <value><array>
		<data>
		  <value><string>CompanyID</string></value>
		  <value><string>Company</string></value>
		  <value><string>Groups</string></value>
		</data>
	  </array></value>
	</param>
  </params>
</methodCall>

All of the variables in braces get replaced with actual ContactID, CompanyID or TagID values.

I’m still using a lot of REST-v1 calls just because I haven’t switched them over to REST-v2 yet (as response structures and call parameters are sometimes different so each one needs to be reviewed for proper operation to catch all the different nuances with the calls). As I won’t be doing this right now, I’ll plan to post further details in a new topic as I run into issues.

The ones I mentioned above were just a couple that I know (or pretty sure :slight_smile: ) aren’t supported in REST-v2.

6

Thanks for sharing these examples, Doug, really helpful. I can confirm that Company tag operations are a gap in v2, and we’ll look into it. Feel free to post any other issues, difficulties, or gaps you run into, we’re happy to review them.