Update ContactGroup

put/v1/contactGroups/update

Updates the groupname and contacts of the existing contactgroup details. Should provide the contactgroup id of the user for this.

Code snippet

curl  --location 'https://api.boldsign.com/v1/contactGroups/update?groupId=10f9d70b-be90-42c3-9295-68d7a1545f40' \
--header 'accept: */*' \
--header 'X-API-KEY: {your API key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "groupName": "Grouptest1000",
    "contacts": [
        {
            "name": "Luther Cooper",
            "email": "luthercooper@gmail.com"
        },
        {
            "name": "Hank White",
            "email": "hankwhite@gmail.com"
        }
    ]
}'

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 GroupContactDetails ()
{
  GroupName = "Testsdk",
  GroupUsers = new List<GroupUser>
  {
    new GroupUser
    {
      Name = "test 01",
      Email = "test01@gmail.com"
    },
      new GroupUser
      {
        Name = "test 02",
        Email = "test02@gmail.com"
      }
  }
};

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

configuration = boldsign.Configuration(
    api_key = "{your API key}"
)

with boldsign.ApiClient(configuration) as api_client:   

  groupcontacts_api = boldsign.GroupContactsApi(api_client)

  group_contact = boldsign.GroupContactDetails(
    groupName="CubeFlakesTeam",
    contacts=[
        boldsign.GroupUser(
            name="Luther Cooper",
            email="luthercooper@cubeflakes.com"
        ),
        boldsign.GroupUser(
            name="Hank White",
            email="hankwhite@cubeflakes.com"
        )
    ]
  )

    update_groupcontact_response = groupcontacts_api.update_groupcontact(
        groupId="YOUR_CONTACT_ID",
        group_contact=group_contact
    )
const axios = require('axios');

axios.put(
  'https://api.boldsign.com/v1/contactGroups/update',
  {
    "groupName": "Grouptest3332",
    "contacts": [
        {
            "name": "Luther Cooper",
            "email": "luthercooper@gmail.com"
        },
        {
            "name": "Hank White",
            "email": "hankwhite@gmail.com"
        }
     ]
  },
   {
    params: {
      groupId:'{Paste your contactgroup ID}',
    },
    headers: {
      accept: '*/*',
      'X-API-KEY':  '{your API key}',
    },
  },
);
<?php
require_once "vendor/autoload.php";

use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Request;

$client = new Client();
$headers = [
  'accept' => '*/*',
  'X-API-KEY' => '{your API key}',
  'Content-Type' => 'application/json'
];

$body = '{
    "groupName" => "Grouptest1",
    "contacts" => [
        {
            "name" => "Luther Cooper",
            "email" => "luthercooper@gmail.com"
        },
        {
            "name" => "Hank White",
            "email"  => "hankwhite@gmail.com"
        }
     ]
}';
$request = new Request('PUT', 'https://api.boldsign.com/v1/contactGroups/update?groupId=6797a07d-26d7-41fa-b3a8-c8f72378a7a6c_ErZHN', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();

Query parameters

idStringRequiredContactGroup Id of the user.

Request body

groupNamestringRequiredThe group name of the user.

contactslistRequired

The list of the contacts

namestringRequiredThe name of the user
emailstringRequiredthe email of the user.

Example response

200 No Content