Resolve an import bundle candidate

PATCH

/api/import-bundles/{id}/candidates/{candidateId}

curl --request PATCH \
  --url https://api.getvespy.com/api/import-bundles/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/candidates/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "action": "edit", "canonicalPayload": {}, "reason": "example", "resolvedEntityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

candidateId

required

string format: uuid

Request Body^required

Media typeapplication/json

object

action

required

string

Allowed values: edit exclude match

canonicalPayload

object

key

additional properties

any

reason

required

string

>= 1 characters <= 500 characters

resolvedEntityId

string format: uuid

Responses

200

Default Response

Media typeapplication/json

object

candidates

required

Array<object>

object

associationReferences

required

Array<object>

object

key

additional properties

any

bundleId

required

string format: uuid

canonicalPayload

required

object

key

additional properties

any

createdAt

required

string format: date-time

externalId

required

string

id

required

string format: uuid

identityAlgorithmVersion

required

string

nullable

identityConfidence

required

string

Allowed values: stable confirmed derived natural manual

identityInputs

required

object

key

additional properties

any

issues

required

Array<object>

object

key

additional properties

any

overrideMetadata

required

object

key

additional properties

any

providerResourceKind

required

string

resolvedEntityId

required

string format: uuid

nullable

sourceFileId

required

string format: uuid

sourceRowNumbers

required

Array<integer>

status

required

string

Allowed values: ready_create ready_update unchanged duplicate_merged ambiguous missing_source_data invalid blocked excluded created updated failed

targetResourceType

required

string

Allowed values: property unit owner tenant lease vendor charge payment expense expense_payment

updatedAt

required

string format: date-time

page

required

integer

>= 1

pageSize

required

integer

>= 1

total

required

integer

totalPages

required

integer

Example

{
  "candidates": [
    {
      "identityConfidence": "stable",
      "status": "ready_create",
      "targetResourceType": "property"
    }
  ]
}

400

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

401

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

404

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}