Partial Update Group

PATCH

https://platform-api.convirza.com/v3/groups/{id}

Groups

Last modified:2026-04-03 14:27:57

Applies a partial update to a group record, modifying only the fields present in the request body. All fields not included in the payload retain their existing values.

Request Body Format
Accepts (all optional): org_unit_name, org_unit_ext_id, org_unit_parent_id, address, city, state, zip, phone_number, industry_id
Tip: Use GET /groups/:id to get the exact format for copy-paste workflow.
Note: Read-only fields (group_created, group_modified) from the GET response will be ignored if included.

Common use cases

Rename a group: { "org_unit_name": "New Name" }

Update address: { "address": "456 Oak St", "city": "Boston" }

Change industry: { "industry_id": 15 }

Constraints

At least one field must be present.

The group must not already be in deleted status.

If org_unit_name is changed, it must remain unique within the parent group.

group_modified timestamp is set automatically.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Group updated successfully

Body

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://platform-api.convirza.com/v3/groups/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "org_unit_name": "Updated Sales Division",
    "org_unit_ext_id": "ORG-2001-UPDATED",
    "org_unit_parent_id": 1001,
    "address": "456 Updated Business Avenue",
    "city": "Los Angeles",
    "state": "CA",
    "zip": "90001",
    "phone_number": "+1987654321",
    "industry_id": 7
}'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "orgUnitId": 1002
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

Modified at 2026-04-03 14:27:57

Update Group

Delete Group