/api/v1/object/{objectSlug}/dedup-ruleSet the duplicate-detection rule of an object.
Set the duplicate-detection rule of an object.
Replaces the whole rule. It applies when a record is created from an
incoming chat and matches existing records on match_keys:
off— no duplicate detection.separate_flag— create a new record and flag it as a duplicate.unify— add the chat to the most recently updated match and create no record.mirror— create a new record, flag it, and show the chat under every match.comment— create a new record, flag it, and post a note on the most recently updated match (comment_targetsoriginal) or on every match (all).
match_keys are field slugs of active fields on this object.
match_logic is or (any key matches) or and (all keys match).
Scope: object.dedupRule.update.
Errors:
400— a match key is not an active field of the object.404— no object has that slug.422— the body is invalid, for example an unknownmode.
Request:
{
"mode": "separate_flag",
"match_keys": ["phone-q8w2e4r6", "email-p0zx7c1v"],
"match_logic": "or"
}
Response 200:
{
"status": 200,
"message": "Deduplication rule updated successfully",
"data": {
"mode": "separate_flag",
"match_keys": ["phone-q8w2e4r6", "email-p0zx7c1v"],
"match_logic": "or"
}
}
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Request body
application/jsonrequiredValues: "off" · "separate_flag" · "unify" · "mirror" · "comment"
Values: "or" · "and"
Responses
Successful response
{
"mode": "off",
"match_keys": "string",
"match_logic": "or",
"comment_targets": "string"
}Values: "off" · "separate_flag" · "unify" · "mirror" · "comment"
Values: "or" · "and"
Bad request
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Unauthorized
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Internal server error
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Powered by heyo-docs