v1

latestOpenAPI 3.1.02026-07-2643134183.4 KB
Object Records

post/objects/{object_name}/records/upsert

Path parameters

object_namestring required

Query parameters

validation_mode'strict' | 'ignore_invalid'

Validation mode to use when validating request data.

strict validation will fail requests if any attribute fails validation, including unrecognized attributes.

ignore_invalid validation will strip out unknown attributes and replace known, non-required attributes with undefined if they fail validation. The request will still fail if the request body does not contain the proper structure or if any required attributes fail validation.

Request body

matchobject required

The attribute values to match against to find an existing record.

At least one unique attribute must be included to ensure that at most one record is matched. Additional unique or non-unique attributes may also be included to refine the matching criteria.

createobject

The attribute values to use when creating a new record if no match is found.

updateobject

The attribute values to use when updating an existing record if a match is found.

update_if_emptyobject

The attribute values to update when a matching record is found and the existing attribute value on the record is null.

create_or_updateobject

The attribute values to apply during both creation and update operations.

create_or_update_if_emptyobject

The attribute values to apply during both creation and update-if-empty operations.

Response

Response for a successful update operation.

status'success' required