POST api/groups

Creates a new contact group with the given information

Request Information

URI Parameters

None.

Body Parameters

Group data of new contact group

GroupNewDTO
NameDescriptionTypeAdditional information
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:
{
  "Name": "sample string 1",
  "Color": "sample string 2"
}

Response Information

Resource Description

Summary of new 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-08-19T15:30:10.5766748+00:00",
  "Modified": "2019-08-19T15:30:10.5766748+00:00",
  "ID": 3,
  "Name": "sample string 4",
  "Color": "sample string 5"
}