topic Re: Batch update contacts with custom idProperty: Not working in Ruby client in APIs & Integrations

Batch update contacts with custom idProperty: Not working in Ruby client

MBerger29 — Sat, 10 Feb 2024 00:33:49 GMT

Hi,

I'm trying to batch update contacts by a custom property instead of by Hubspot ID. Things work as expected in CURL, however the same code done through the ruby hubspot client (17.2.0) just quietly doesn't work (returns no results, status="COMPLETE").

Code that works in CURL:

curl --request POST \
--url https://api.hubapi.com/crm/v3/objects/contacts/batch/update \
--header 'authorization: Bearer my-token' \
--header 'content-type: application/json' \
--data '{
"inputs": [
{
"idProperty": "along_email",
"id": "test@test.com",
"properties": {
"lastname": "Doe",
"firstname": "John",
"along_short_name": "My updated name from CURL"
}
}
]
}'

Code that always returns no results in Ruby:

properties = {
  "lastname": "Doe",
  "firstname": "John",
  "along_short_name": "My updated name from Ruby Client"
}
body = { inputs: [
  {idProperty: "along_email", id: "test@test.com", "properties": properties}
] }

api_response = client.crm.contacts.batch_api.update(body: body)
puts api_response

Should I just assume that `idProperty` isn't available for batch updating contacts?

Re: Batch update contacts with custom idProperty: Not working in Ruby client

zach_threadint — Tue, 05 Mar 2024 03:02:59 GMT

Hi @MBerger29 👋

I've been able to replicate the issue you are experiencing. The API documentation certainly makes it seem as though this should be possible with the Ruby API Client, but it doesn't work as expected. It'd be great if someone from HubSpot could take a look at this @Jaycee_Lewis 🙌

In the meantime, is there a Ruby package that allows you to construct HTTP requests directly to HubSpot's APIs? I prefer Python, which has the requests package for this.

I hope this proves useful. Please let me know if you have any follow-up questions.

Re: Batch update contacts with custom idProperty: Not working in Ruby client

MBerger29 — Wed, 14 Feb 2024 17:01:58 GMT

Thanks for looking, Zach. Yep we could in theory construct a CURL call for just this endpoint, but would be a pain (we're hoping to leverage the retry logic of the ruby client across all endpoints).

Seems like at the minimum there should be an error if this flow isn't supported as opposed to quietly not working (feedback for Hubspot)

Re: Batch update contacts with custom idProperty: Not working in Ruby client

RyanCreveling — Tue, 27 Feb 2024 16:38:22 GMT

Hey @MBerger29

Just wanted to chime in here that I ran into this exact issue using Node.js / JavaScript, as well. As @zach_threadint mentioned, it does seem like it should be possible based on the documentation (especially as it works there in the "Node" code editor view)

In my case, I reconstructed the exact call I was trying to make with my code in the documentation to batch update based on custom property with the unique value requirement. This worked using the "Test call" function there. However, when I test the same call in a Custom Coded workflow action, or in VS Code, the call fails with the following error:

{ "status": "COMPLETE", "results": [], "numErrors": 1, "errors": [ { "status": "error", "category": "OBJECT_NOT_FOUND", "message": "Could not get some DEAL objects, they may be deleted or not exist. Check that ids are valid.", "context": { "ids": [ "100001", "100002" ] } } ], "startedAt": "2024-02-27T16:12:33.882Z", "completedAt": "2024-02-27T16:12:33.903Z" }

I copied the input array of objects generated in the docs to a variable in my code and tried that as the input value to double check if my code was just incorrectly constructing the object. I ended up getting the same error using the input from the docs, so it seems like the issue is on their end (or it's not possible yet, which would make the documentation misleading because it works there).

Not sure if there's going to be a resolution to this in the foreseeable future; for now I plan to use the Batch Read endpoint using the custom unique ID property to pull the default Deal IDs, then batch update them using that. Not ideal by any means but it'll work for now.

Re: Batch update contacts with custom idProperty: Not working in Ruby client

BérangèreL — Wed, 28 Feb 2024 08:22:47 GMT

Hi @MBerger29, @zach_threadint and @RyanCreveling,

Thank you for reaching out to the Community!

I'm sorry to hear about your experience regarding this.

I would like to apologize for the frustration, data issues, and business impact this has caused.

I'd like to thank you for sharing your valuable feedback! This means a lot to us.

I have shared it internally to bring more visibility to it and I have asked the team to have a look at the documentation and edit it if necessary.

Thanks a lot @zach_threadint for the tag and the API documentation link, much appreciated!

I'll get back to you as soon as I hear from the team, thanks for your patience.

Please let me know if there is anything else I can help with. I'll be delighted to do so!

Best,
Bérangère

Re: Batch update contacts with custom idProperty: Not working in Ruby client

BérangèreL — Mon, 25 Mar 2024 13:49:02 GMT

Hi @MBerger29, @zach_threadint and @RyanCreveling, I hope that you are well!

Thanks for your patience!

I heard back from the Team and great news: they are just adding this option!

It's not yet available for those languages, but it is coming soon! I don't have a precise timeline for it but they are working on it as we speak!

Have a great day!

Best,
Bérangère

Re: Batch update contacts with custom idProperty: Not working in Ruby client

zach_threadint — Tue, 26 Mar 2024 08:58:34 GMT

Hi @BérangèreL 👋

That's great news, thanks very much for the update 🙂

Re: Batch update contacts with custom idProperty: Not working in Ruby client

BérangèreL — Thu, 09 May 2024 11:29:22 GMT

Hi @MBerger29, @zach_threadint and @RyanCreveling,

I hope that you are all doing well!

Just to let you know that we released an update (Ruby v.18.0.0) and this fixed the behavior 🙂

I hope this helps!

Have a lovely day!

Best,
Bérangère

Re: Batch update contacts with custom idProperty: Not working in Ruby client

zach_threadint — Fri, 24 May 2024 05:42:41 GMT

Awesome, thanks for the update @BérangèreL 🙌