Send message about dispute to other party

Sends a message about a dispute, by ID, to the other party in the dispute. Merchants and customers can only send messages if the dispute_life_cycle_stage value is INQUIRY. For constraints and rules regarding documents that can be attached as part of the message, see documents. To send a message, use the send-message link in the HATEOAS links of the show dispute details response and specify the message in the JSON request body. In case the link is not present in the response you can’t send a message on the dispute.

POST /v1/customer/disputes/{id}/send-message

Send message about dispute to other party

cURL

curl --request POST \
  --url https://api-m.sandbox.paypal.com/v1/customer/disputes/{id}/send-message \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form message_document='@example-file'

200

{
  "links": [
    {
      "href": "<string>",
      "rel": "<string>"
    }
  ]
}

Authorizations

Oauth2Oauth2

Authorization · string · header · required

Oauth 2.0 authentication

Path Parameters

id · string · required

The ID of the dispute for which to provide the supporting information.

Required string length: 1 - 255

Pattern: ^[A-Za-z0-9-]+$

Body

multipart/form-data

message_document · file

A file that contains any additional info about the message posted.

Response

200

application/json

A successful request returns the HTTP 200 OK status code and a JSON response body that includes a link to the dispute.

The subsequent action.

links · Link Description · object[] · read-only

An array of request-related HATEOAS links.

Required array length: 1 - 10 elements

Show child attributes