Upsert custom property values
POST/api/v1/bulk/custom-property-values/upsert
This request is queued, not processed while you wait. The response carries a correlation id — poll the bulk task until it reports a terminal state. See How asynchronous processing works.
Queued, not immediate. The response carries a correlation id; poll GET /api/v2/bulk/tasks/{correlationId} until the task reports a terminal state. Per-pair results are not returned through the API; review outcomes in the BeCause app under Company Manager → Import/Export → API usage. Each entry names one company — either by its BeCause company id, or by the stored value of one of your own String-type custom properties (for example the id your system keys the company by) — and lists the custom property values to set on it. Each (company, property) pair replaces that property's whole value set, and an empty value list clears it. The identifying value must match exactly one company; entries matching none or several fail per pair with a named reason. At most 50,000 (company, property) pairs per request, and no two entries may name the same company the same way; a company reached both by id and by identifier value fails per pair instead of being rejected up front.
Request
Responses
- 200
- 400
- 403
Queued. The correlation id means the import has started, not that any value has been written yet.
Returned when the companies list is empty, when an entry's identifying company id or custom property
doesn't set exactly one of the two, when an entry has no custom property values, when a custom property
value entry is missing its id or contains a blank or duplicate value, when a custom property is repeated
within one entry, when the request exceeds the 50,000-pair cap, or when two entries name the same company
the same way.
Returned when the API key is missing, invalid or inactive. Ownership of the custom properties in the
request — including the identifying one — is checked while the queued request processes; failures are
reported per row as "NotPropertyOwner" in the finished request.