DuplicateActionResponse

Fields

Result of a dismiss / merge action on a candidate pair.

3 fields

candidate_id · required

string (uuid)

deprecated_case_id

string (uuid) or null

status · required

string

Raw schema (JSON)

{
  "description": "Result of a dismiss / merge action on a candidate pair.",
  "properties": {
    "candidate_id": {
      "format": "uuid",
      "title": "Candidate Id",
      "type": "string"
    },
    "deprecated_case_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Deprecated Case Id"
    },
    "status": {
      "enum": [
        "open",
        "merged",
        "dismissed"
      ],
      "title": "Status",
      "type": "string"
    }
  },
  "required": [
    "candidate_id",
    "status"
  ],
  "title": "DuplicateActionResponse",
  "type": "object"
}

Used by endpoints

2 endpoints send or return this schema, on its own or inside another schema.

• POST /api/v1/projects/{project_id}/duplicate-candidates/{candidate_id}/dismiss — Dismiss Duplicate Candidate
• POST /api/v1/projects/{project_id}/duplicate-candidates/{candidate_id}/merge — Merge Duplicate Candidate

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON