Edit milestone

This endpoint allows you to update the details of a specific party and user within an escrow service.

Edit milestone

PATCH v2/escrow/milestone/edit/milestone_id/user_id

Params

NameTypeDescription

milestone_id

String

The ID of the of the milestone to be edited

user_id

String

The ID of the user

Headers

NameTypeDescription

Accept*

string

application/json

V-PRIVATE-KEY*

string

your vesicash private key

V-PUBLIC-KEY*

String

your vesicash public key

Request body

  • title (string, optional): The new title for the milestone.

  • description(string, optional): The new melestone description

  • inspection_period(string, optional): The duration of the inspection period in hours

  • grace_period:(string, optional): The grace period in hours

  • due_date(string_optional): The due date of the milestone

{
    "title": "The new milestone tittle",
    "description": "description",
    "inspection_period": 26,
    "grace_period": 26,
    "due_date": "2024-04-19 16:04:05"

Response

Upon successful execution, the endpoint returns a status code of 200 and a JSON response with the following structure:

{
    "status": "success",
    "code": 200,
    "message": "success",
    "data": {
        "bank_account": {
            "account_name": "Chi H",
            "account_number": "1234567890",
            "bank_code": "VE000",
            "bank_name": "Vesicash"
        },
        "created_at": "2024-07-15T14:00:22.711256Z",
        "email": "ade10@inboxkitten.com",
        "first_name": "Ade",
        "has_accepted": true,
        "id": 264,
        "is_initiator": false,
        "last_name": "Tolu",
        "percentage": 0,
        "phone": "+2349043956435",
        "role": "buyer",
        "role_description": "service seller",
        "transaction_id": "tr50fa18ad05e647b8b910",
        "transaction_party_id": "a97abd76ff8745e3b7b0",
        "updated_at": "2024-07-15T14:38:25.08535343Z",
        "user_id": "9226511842"
    }
}

For example, you can make a PATCH request to the endpoint above and pass in the raw json data below to edit party.

{
    "email": "ade10@inboxkitten.com",
    "first_name": "Ade",
    "last_name": "Tolu",
    "phone": "+2349043956435",
    "is_initiator": false,
    "role_description": "service seller",
    "bank_account": {
        "bank_name": "Vesicash",
        "bank_code": "VE000",
        "account_number": "",
        "account_name": "Chi H"
    }
}

Last updated