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.