Update Person (Partial)
๐งพ Update Person (Partial)
Endpoint: PATCH /api/v3/persons/{personId}
Auth Required: โ Yes (Bearer Token)
๐ Description
Partially updates fields for a specific person identified by their ID. Use this endpoint to change one or more fields without needing to submit the full record.
๐ข URL Parameters
Parameter | Type | Required | Description |
---|---|---|---|
personId |
integer or string | โ Yes | Unique identifier of the person. |
๐ Query Parameters
None.
๐ฅ Request Body
Content-Type: application/json
Submit only the fields you wish to update.
๐ง Sample Schema
{ "<fieldToUpdate>": "<newValue>", "<anotherField>": true }
๐ค Request Example
PATCH https://api.briefingedge.com/api/v3/persons/98765 Authorization: Bearer <token> Content-Type: application/json { "jobTitle": "Director", "active": true }
โ Success Response (200 OK)
Returns the updated Person
object.
Example:
{ "PersonID": 98765, "FirstName": "Taylor", "LastName": "Jordan", "JobTitle": "Director", "IsActive": true }
โ Error Responses
Code | Message | Description |
---|---|---|
400 | Bad Request | Invalid field names or data types. |
401 | Unauthorized | Missing or invalid bearer token. |
404 | Not Found | No person found with the given ID. |
500 | Internal Server Error | Unexpected server-side failure. |