How To Use The Rest API End Point - Update Records

Use this end-point to create records in your database. Only 1 record at a time can be posted in the request.

PATCH Type End-Point

/api/v1/collect/data/{record}/{rowid}

Request Body

Only the fields that are being updated need to be in the Request Body.

{
  "data": {
    "field": "string",
    "field": "string",
    ...
  }
}

Example

The below code updates the Status and Type on Debtor with rowid 123.

/api/v1/collect/data/debtor/123

{
  "data": {
    "de_type": "RET",
    "de_status": "NEW",
  }
}

Response Body

The response will include a status value. 200 is good. Everything else is a failure. If the response is good, then the response will include the Data Type and Data.

{
  "type": {
    "recId": "string",
    "rowId": "string"
  },
  "data": {
    "field": "string",
    ...
  }
}

Code	Description
recId	This is the table name in the database.
rowId	This is the column name for the unique identifier for this table.

Example

{
  "type": {
    "recId": "debtor",
    "rowId": "de_rowid"
  },
  "data": {
    "de_rowid": "123",
    ...
  }
}

Was this page helpful? Do you have any comments on this document? Can we make it better? If so how may we improve this page.

Please click this link to send us your comments: helpinfo@collect.org