hs_unique_creation_key usage

Hello.

I’m using the HubSpot API to integrate it with my system and I wanted more clarity on how to use the `hs_unique_creation_key` property. I see it listed in the properties of every object type, but I don’t see any documentation of it.

Based on the description,

Unique property used for idempotent creates

I imagine we can use it as an idempotent key when creating objects, however I’m getting this error when trying to do so:

POST {{HUBSPOT_V3}}/objects/companies

{

“properties”: {

“name”: “my-test-company”,

“hs_unique_creation_key”: “a27ace68-dad0-4eec-86c3-e59b0614f29d”

}

}

{

“status”: “error”,

“message”: “Property values were not valid: [{\“isValid\”:false,\“message\”:\”\\\“hs_unique_creation_key\\\” is a read only property; its value cannot be set.\“,\“error\”:\“READ_ONLY_VALUE\”,\“name\”:\“hs_unique_creation_key\”,\“localizedErrorMessage\”:\”\\\“hs_unique_creation_key\\\” is a read only property; its value cannot be set.\“,\“propertyValue\”:\“a27ace68-dad0-4eec-86c3-e59b0614f29d\”,\“portalId\”:23327928}]”,

“correlationId”: “959d03d0-eac8-45d6-8c62-7a39b77f398f”,

“category”: “VALIDATION_ERROR”

}

Is is yet supported? Am I using it the wrong way? Any help is appreciated.

Hi, @FBizzotto :waving_hand: Welcome to the community.

The error message you shared tells us the answer — the `hs_unique_creation_key` property is read-only and cannot be set directly via API calls. This property is intended for use by internal systems to ensure idempotent creation of objects. This property is managed by HubSpot and not intended for direct manipulation by users, either through the UI or programmatically via API calls.

I hope this helps get you moving forward.

Best,

Jaycee