For archived content, access the previous documentation here or the previous API reference here.

Update text evidence

Prev Next
Patch
/v1/disputes/{dispute_id}/evidences/{evidence_id}

Replace the text content of a previously submitted TEXT evidence item. Only TEXT evidence can be modified; FILE evidence must be deleted and re-uploaded. The dispute must still be in ACTION_REQUIRED status.

Security
HTTP
Type basic
Path parameters
dispute_id
stringRequired

Unique identifier of the dispute that owns this evidence.

evidence_id
stringRequired

Unique identifier of the evidence item to update.

Body parameters
object
text_content
string Required

Updated text content.

Responses
204

Evidence text content updated successfully.

400

Invalid request.

{
  "error_code": "INVALID_REQUEST",
  "message": "Text content must not be blank."
}
object
error_code
string
ExampleILLEGAL_STATE
message
string
ExampleThe requested action is not allowed in the current dispute state.
404

Dispute or evidence not found.

dispute_not_found
{
  "error_code": "DISPUTE_NOT_FOUND",
  "message": "The specified dispute was not found."
}
evidence_not_found
{
  "error_code": "EVIDENCE_NOT_FOUND",
  "message": "Evidence ID 'mi-dspt-evd-12345' does not exist or is not accessible."
}
object
error_code
string
ExampleILLEGAL_STATE
message
string
ExampleThe requested action is not allowed in the current dispute state.
409

Evidence update not allowed in the current dispute state.

{
  "error_code": "ILLEGAL_STATE",
  "message": "The requested action is not allowed in the current dispute state."
}
object
error_code
string
ExampleILLEGAL_STATE
message
string
ExampleThe requested action is not allowed in the current dispute state.
422

Evidence is not a text type.

{
  "error_code": "EVIDENCE_NOT_TEXT",
  "message": "Only TEXT evidence can be updated. This evidence is of type FILE."
}
object
error_code
string
Valid values[ "EVIDENCE_NOT_TEXT" ]
message
string