Submit correction

POST

https://api.sureshake.com/v2/directory/{subjectType}/{listingId}/corrections

Path parameters

subjectType
person
or
entity
required

listingId
string
required
format: uuid

Request body JSON required

kind
field_correction
or
duplicate_report
required
proposedCanonicalListingId
optional
string
format: uuid
field
optional
string
maxLength: 255 · minLength: 1
proposedValue
optional
string
maxLength: 2000 · minLength: 1
note
optional
string
maxLength: 2000 · minLength: 1
evidenceUrl
optional
string
format: uri · maxLength: 2000

Returns

201

Default Response

JSON

data
object
required
- id
  string
  required
  format: uuid
- listingId
  string
  required
  format: uuid
- proposedCanonicalListingId
  string
  or null
  required
  format: uuid
- subjectType
  person
  or
  entity
  required
- kind
  field_correction
  or
  duplicate_report
  required
- field
  string
  or null
  required
- proposedValue
  string
  or null
  required
- note
  string
  or null
  required
- evidenceUrl
  string
  or null
  required
- submittedByUserId
  string
  required
- status
  pending
  or
  accepted
  or
  rejected
  or
  dismissed
  required
- disputeVisible
  boolean
  required
- reviewedByUserId
  string
  or null
  required
- reviewedAt
  string
  or null
  required
  format: date-time
- resolutionNote
  string
  or null
  required
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

429

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

503

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

Submit correction

curl --request POST \
  --url 'https://api.sureshake.com/v2/directory/person/<listingId>/corrections' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kind": "field_correction",
  "proposedCanonicalListingId": "25e80c76-032c-4937-8352-5b6509442364",
  "field": "string",
  "proposedValue": "string",
  "note": "string",
  "evidenceUrl": "http://example.com"
}
'

const url = 'https://api.sureshake.com/v2/directory/person/<listingId>/corrections';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    kind: 'field_correction',
    proposedCanonicalListingId: '25e80c76-032c-4937-8352-5b6509442364',
    field: 'string',
    proposedValue: 'string',
    note: 'string',
    evidenceUrl: 'http://example.com'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.sureshake.com/v2/directory/person/<listingId>/corrections"

payload = {
    "kind": "field_correction",
    "proposedCanonicalListingId": "25e80c76-032c-4937-8352-5b6509442364",
    "field": "string",
    "proposedValue": "string",
    "note": "string",
    "evidenceUrl": "http://example.com"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "listingId": "8c73d933-f7ed-437e-9da1-caac95adc1ae",
    "proposedCanonicalListingId": "25e80c76-032c-4937-8352-5b6509442364",
    "subjectType": "person",
    "kind": "field_correction",
    "field": "string",
    "proposedValue": "string",
    "note": "string",
    "evidenceUrl": "string",
    "submittedByUserId": "string",
    "status": "pending",
    "disputeVisible": true,
    "reviewedByUserId": "string",
    "reviewedAt": "2019-08-24T14:15:22Z",
    "resolutionNote": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}