Update Group

PUT

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

Groups

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

Performs a full update of a group record. All fields in the request body overwrite the stored values.

Request Body Format
Accepts: 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.

When to use PUT vs PATCH
Use PUT when updating multiple fields simultaneously or when your client always sends the full group object. Use PATCH for targeted single-field changes. Both accept the same request body format.

Constraints

org_unit_name must remain unique within the parent group.

The parent_org_unit_id cannot be changed to an org unit that is itself a descendant of this group (circular hierarchy is rejected).

group_modified timestamp is set automatically.

Response
Returns a success flag. Retrieve the updated record using GET /groups/:id.

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 PUT '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

Get Org Unit Hierarchy

Partial Update Group