API ReferenceGroups

Update

Partially updates a group's name or external reference ID. Returns 404 if the group does not belong to the authenticated organization.

Authentication

AuthorizationBearer

API Key or Access Token authentication using Bearer token in Authorization header. API keys use the vit_apk_ prefix, access tokens use the vit_at_ prefix.

Path parameters

group_idstringRequired

Unique group identifier (grp_*)

Request

This endpoint expects an object.
namestring or nullOptional1-255 characters
New display name for the group. Omit to leave unchanged.
external_reference_idstring or nullOptional<=255 characters
New external reference ID for the group. Omit to leave unchanged.

Response headers

X-RateLimit-Limitinteger
Maximum number of requests allowed within the rate limit window
X-RateLimit-Remaininginteger
Number of requests remaining in the current rate limit window
X-RateLimit-Resetinteger

Unix timestamp (seconds) when the rate limit window resets

Response

dataobject
The group record.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error