PUT api/groups/{group}

Updates a given contact group with the given information. NOTE! Existing information is replaced entirely with the new information set.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
group

Group ID

integer

Required

Body Parameters

Updated group data

GroupUpdateDTO
NameDescriptionTypeAdditional information
ID

Contact group ID

integer

Required

Name

Contact group name

string

Required

Color

Contact group color, hexadecimal (ex. #ffffff)

string

Matching regular expression pattern: ^#([A-Fa-f0-9]{6})$

Request Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "Name": "sample string 2",
  "Color": "sample string 3"
}

Response Information

Resource Description

Summary of updated group

GroupDTO
NameDescriptionTypeAdditional information
OwnerID

ID of account owning the contact group

string

None.

ContactsCount

Amount of contacts in the group

integer

None.

Created

Timestamp when contact group was added

date

None.

Modified

Timestamp when contact group was last modified

date

None.

ID

Contact group ID

integer

Required

Name

Contact group name

string

Required

Color

Contact group color, hexadecimal (ex. #ffffff)

string

Matching regular expression pattern: ^#([A-Fa-f0-9]{6})$

Response Formats

application/json, text/json

Sample:
{
  "OwnerID": "sample string 1",
  "ContactsCount": 2,
  "Created": "2019-10-23T12:07:39.0791724+00:00",
  "Modified": "2019-10-23T12:07:39.0791724+00:00",
  "ID": 3,
  "Name": "sample string 4",
  "Color": "sample string 5"
}