Documentation/Update ContactGroup

Update ContactGroup

put/v1/contactGroups/update

This API allows you to update the group name, directories, and contacts in an existing contact group.

Code snippet

curl  -X PUT 'https://api.boldsign.com/v1/contactGroups/update?groupId=10f9d70b-be90-42c3-9295-68d7a1545f40' \
-H 'accept: */*' \
-H 'X-API-KEY: {your API key}' \
-H 'Content-Type: application/json' \
-d '{
    "GroupName": "Grouptest1000",
    "Contacts": [
        {
            "Name": "Luther Cooper",
            "Email": "luthercooper@gmail.com"
        },
        {
            "Name": "Hank White",
            "Email": "hankwhite@gmail.com"
        }
    ],
    "Directories": ["Sales", "Legal"]
}'

var apiClient = new ApiClient("https://api.boldsign.com", "{apikey}");
var groupContactClient = new GroupContactClient(apiClient);
var groupId = "6797a07d-26d7-41fa-b3a8-c8f72378a7a6c_ErZHN";
var groupContact = new GroupContact ()
{
  GroupName = "Testsdk",
  Contacts = new List<Contacts>
  {
    new Contacts
    {
      Name = "LutherCooper",
      Email = "luthercooper@cubeflakes.com"
    },
      new Contacts
      {
        Name = "hankwhite",
        Email = "hankwhite@cubeflakes.com"
      }
  },
  Directories = new List<string> { "Sales", "Legal" }
};

await groupContactClient.UpdateGroupContactAsync(groupId, groupContact).ConfigureAwait(false);
import boldsign

configuration = boldsign.Configuration(api_key = "YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:

    group_contacts_api = boldsign.GroupContactsApi(api_client)
    contact1 = boldsign.GroupUser(
        name="LutherCooper",
        email="luthercooper@cubeflakes.com"
    )
    contact2 = boldsign.GroupUser(
        name="hankwhite",
        email="hankwhite@cubeflakes.com"
    )
    update_group_contact = boldsign.UpdateGroupContact(
        groupName="Test Group",
        directories=["directory"],
        contacts=[contact1, contact2]
    )
    group_contacts_api.update_group_contact(
        group_id="YOUR_GROUP_ID",
        update_group_contact=update_group_contact
    )
<?php
require_once "vendor/autoload.php";

$config = new BoldSign\Configuration();
$config->setApiKey('YOUR_API_KEY');
$apiInstance = new BoldSign\Api\GroupContactsApi($config);
$update_contact = new BoldSign\Model\UpdateGroupContact();
$update_contact->setDirectories(['new_directory_id_1']);
$update_contact->setGroupName("Updated Group Name");
$apiInstance->updateGroupContact("YOUR_GROUP_ID", $update_contact);
import { GroupContactsApi, GroupUser, UpdateGroupContact } from "boldsign";

const contactGroupApi = new GroupContactsApi();
contactGroupApi.setApiKey("YOUR_API_KEY");
var groupUser1 = new GroupUser();
groupUser1.email = "luthercooper@cubeflakes.com";
groupUser1.name = "LutherCooper";

var updateGroupContact = new UpdateGroupContact();
updateGroupContact.contacts = [groupUser1];
updateGroupContact.groupName = "Group1 Updated";
updateGroupContact.directories = ["dictionary_1"];
contactGroupApi.updateGroupContact("YOUR_GROUP_ID",updateGroupContact);
ApiClient apiClient = Configuration.getDefaultApiClient();
apiClient.setApiKey("YOUR_API_KEY");
GroupContactsApi groupContactApi = new GroupContactsApi(apiClient);
GroupUser groupUser1 = new GroupUser();
groupUser1.setName("LutherCooper");
groupUser1.setEmail("luthercooper@cubeflakes.com");
UpdateGroupContact groupContactDetails = new UpdateGroupContact();
groupContactDetails.setGroupName("Group A_Updated");
groupContactDetails.setContacts(Arrays.asList(groupUser1));
groupContactDetails.setDirectories(Arrays.asList("dict_1"));
groupContactApi.updateGroupContact("YOUR_GROUP_ID", groupContactDetails);

Query parameters

idStringRequiredContactGroup Id of the user.

Request body

GroupNamestringThe group name of the user.

Contactslist

The list of the contacts

NamestringRequiredThe name of the user
EmailstringRequiredthe email of the user.
DirectorieslistThe list of directories to associate with the contact group.

Example response

200 No Content