DESCRIPTION
This endpoint edits the details of an existing matter with the provided parameters.
Mattercodes provided in the URL argument that contain the the following special characters will need them replacing with these alternatives:
| Character | Replacement |
| \ | {BACKSLASH} |
| / | {FORWARDSLASH} |
| . | {DOTPERIOD} |
URL STRUCTURE
https://[hostname]/matter/edit/{matter}METHOD
POST
HEADERS
**Authorization:** string Base64 [email]:[key]
ARGUMENTS
| Name | Type | Description |
|---|---|---|
| matter | int|string | Required. Matter id or mattercode |
PARAMETERS
| Name | Type | Description |
|---|---|---|
| category | int|string | Required. Matter category id, or name of matter category as it appears in the system, e.g. "9" or "Patent". |
| subcategory | int|string | Matter subcategory id or name/partial name of subcategory. |
| country | string | Required. Two letter country code. |
| client | int|string | Required. If int: the id of an organisation in the address book. If string: Exact name of client in address book, or new client is created and linked to case. |
| title | string | Required. |
| longTitle | string | |
| user | int|string | Required. User id or exact username of user |
| whoPaysTheBill | int|string | ID of location in address book or exact name of location in address book. |
| user2 | int|string | User id or exact username of user. |
| user3 | int|string | User id or exact username of user. |
| user4 | int|string | User id or exact username of user. |
| priority-date | string | |
| priority-country | string | |
| priority-code | string | |
| application-date | string | |
| application-country | string | |
| application-code | string | |
| publication-date | string | |
| publication-country | string | |
| publication-code | string | |
| grant-date | string | |
| grant-country | string | |
| grant-code | string | |
| natreg-entry-date | string | |
| natreg-entry-country | string | |
| natreg-entry-code | string | |
| natreg-publication-date | string | |
| natreg-publication-country | string | |
| natreg-publication-code | string | |
| history-dates | array | {
"202": {
"date": "2023-10-25",
"country": "GB",
"code": "111111.1"
}
}
|
| applicants | array | Can be: ID of applicant in address book, exact name of applicant in address book or new applicant which will be added to the address book and linked to the matter.{
50,
'Applicant Name',
'New Applicant',
}
|
| inventors | array | Can be: ID of inventor in address book, exact name of inventor in address book or new inventor which will be added to the address book and linked to the matter.{
50,
'Inventor Name',
'New Inventor',
}
|
| custom-fields | array | Json array of custom field ID's with corresponding values.{
"621": "Mechanised Suit"
}
|
| mattercode | string | Must not exist for the subscriber account already. |
RETURNS
200: "Matter Updated", 400: "Invalid argument message", 500: "Error message"
| Code | Message | Status |
| 200 | Matter Updated | Successful |
| 400 | Invalid argument (name of invalid argument) | Failure |
| 500 | Error message | Failure |