Update a Party

Use the following details to update a Party using the REST interface:

HTTP Method

PUT

Endpoint URL

See the REST Service Endpoint topic for more details.

Resource

/restapi/v1/party/{id}

Request Parameters

Provide values for the following parameters:

Parameter Name Data Type Mandatory
createdBy string No
createdOn dateTime No
deleted boolean No
id string No
lastUpdatedBy string No
locked boolean No
name string No
ownedBy string No
parentPartyId string No
ref string No
sid   No
status string No
subType string No
type string No
updatedOn dateTime No
version   No
batchid   No

Request Model

Media Type: application/json

{
  "version": 0,
  "type": "string",
  "id": "string",
  "status": "string",
  "subType": "string",
  "tenantId": "string",
  "batch": {
    "id": "string",
    "sid": 0
  },
  "updatedOn": "2022-08-04T04:38:57.323Z",
  "ref": "string",
  "sid": 0,
  "createdBy": "string",
  "locked": true,
  "createdOn": "2022-08-04T04:38:57.323Z",
  "ownedBy": "string",
  "lastUpdatedBy": "string",
  "deleted": true,
  "parentPartyId": "string",
  "name": "string"
}

Response Model

{
  "data": {
    "createdBy": "string",
    "createdOn": "2016-07-31T05:17:59.056Z",
    "deleted": true,
    "id": "string",
    "lastUpdatedBy": "string",
    "locked": true,
    "name": "string",
    "ownedBy": "string",
    "parentPartyId": "string",
    "ref": "string",
    "sid": 0,
    "status": "string",
    "subType": "string",
    "type": "string",
    "updatedOn": "2016-07-31T05:17:59.056Z",
    "version": 0
  },
  "duration": 0,
  "result": {
    "code": "string",
    "message": "string",
    "params": [
      "string"
    ]
  },
  "startTimestampMS": 0
}