API explorerChangelog
Overview

Sections

API explorer
Changelog

Theme switcher

Rename existing group

This endpoint allows you to rename a group for a specific group type and name combination. Once the request is executed successfully, all profiles associated with the original group will now be associated with the new group.

Additionally, we've included an AllowMerge field that must be set to true if the new group name already exists for the same group type. For example, if you have Group A and Group B under the same group type, and you rename Group A to Group B with AllowMerge set to true, profiles from Group A that aren't already in Group B will be moved to Group B, and Group A will be deleted. If AllowMerge is set to false, the API will reject the request.

Header Parameters

Authorizationstring Required

Authorization token

Content-Typestring

Path Parameters

clientIdstring Required

This is your organization’s MyPreferences Account Id. A 404 is returned if this value is invalid.

groupTypestring

Name of the groupType associated with the group you want to rename.

Body Parameters

OldGroupNamestring

The current name of the group you want to rename.

NewGroupNamestring

The new name you want to assign to the group.

AllowMergeboolean

Must be set to true if the new group name already exists for the specified group type.

Response

200
Object
The request was successfully processed.
400
Object
The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again.
401
Object
Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
403
Object
The authentication credentials were insufficient to grant access to the requested resource. In most cases, your user may not have the appropriate permissions to access the requested resource. Verify User Group permissions for your user before trying again.
404
Object
The requested resource cannot be found.  Most errors in this category are returned when a resource specified on the URL path is not found. In certain instances, it is also returned when a parameter specified in the request body is also not found.
503
Object
The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.
Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?