POST api/clients/{clientId}/contacts/add

Adds a new contact to a client.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	the id of the client to whom the contact is being added.	integer	Required

Body Parameters

an object that contains the data that will be used to fill up the new contact.

AddClientContactInput

Name	Type	Additional information
ContactTypeId	integer	None.
Name	string	None.
Address1	string	None.
Address2	string	None.
Phone	string	None.
PhoneAlternative	string	None.
Email	string	None.
PhoneMobile	string	None.
Relationship	string	None.
IsAbleToReleaseInformation	boolean	None.
DateReleasedInfoExpires	date	None.
City	string	None.
StateAbbreviation	string	None.
ZipCode	string	None.
DateReleasedInfoStarts	date	None.
Notes	string	None.
AgencyId	integer	None.
IsMobileVisitDestAddress	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "ContactTypeId": 2,
  "Name": "sample string 3",
  "Address1": "sample string 4",
  "Address2": "sample string 5",
  "Phone": "sample string 6",
  "PhoneAlternative": "sample string 7",
  "Email": "sample string 8",
  "PhoneMobile": "sample string 9",
  "Relationship": "sample string 10",
  "IsAbleToReleaseInformation": true,
  "DateReleasedInfoExpires": "2026-05-07T23:24:20.7527343-04:00",
  "City": "sample string 12",
  "StateAbbreviation": "sample string 13",
  "ZipCode": "sample string 14",
  "DateReleasedInfoStarts": "2026-05-07T23:24:20.7682484-04:00",
  "Notes": "sample string 15",
  "AgencyId": 1,
  "IsMobileVisitDestAddress": true
}

application/xml, text/xml

Sample:

<AddClientContactInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CWI.Mobile.Domain.DTO.ActionInputs">
  <Address1>sample string 4</Address1>
  <Address2>sample string 5</Address2>
  <AgencyId>1</AgencyId>
  <City>sample string 12</City>
  <ContactTypeId>2</ContactTypeId>
  <DateReleasedInfoExpires>2026-05-07T23:24:20.7527343-04:00</DateReleasedInfoExpires>
  <DateReleasedInfoStarts>2026-05-07T23:24:20.7682484-04:00</DateReleasedInfoStarts>
  <Email>sample string 8</Email>
  <IsAbleToReleaseInformation>true</IsAbleToReleaseInformation>
  <IsMobileVisitDestAddress>true</IsMobileVisitDestAddress>
  <Name>sample string 3</Name>
  <Notes>sample string 15</Notes>
  <Phone>sample string 6</Phone>
  <PhoneAlternative>sample string 7</PhoneAlternative>
  <PhoneMobile>sample string 9</PhoneMobile>
  <Relationship>sample string 10</Relationship>
  <StateAbbreviation>sample string 13</StateAbbreviation>
  <ZipCode>sample string 14</ZipCode>
</AddClientContactInput>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AddClientContactInput'.

Response Information

Resource Description

An Http response message with the following status codes: 200 = success (includes the Id of the recently added client contact), 400 = bad request (the request is malformed or with invalid data), 404 = not found (this is returned when the supplied client Id can't be found.) 500 = something went wrong (the request was not processed).

UIClientContact

Name	Type	Additional information
clientContactId	integer	None.
clientId	integer	None.
contactTypeId	integer	None.
contactTypeName	string	None.
name	string	None.
address1	string	None.
city	string	None.
stateAbbreviation	string	None.
zipCode	string	None.
phone	string	None.
phoneAlternative	string	None.
phoneMobile	string	None.
email	string	None.
relationship	string	None.
externalId	string	None.
clientVisitId	integer	None.
visitMapGroup	byte	None.
isAbleToReleaseInformation	boolean	None.
dateReleasedInfoExpires	date	None.
updatedByEmployeeId	integer	None.
dateReleasedInfoStarts	date	None.
notes	string	None.
address2	string	None.
agencyId	integer	None.
agencyName	string	None.
source	string	None.
isMobileVisitDestAddress	boolean	None.
dateCreated	date	None.
dateUpdated	date	None.
state	string	None.
date	date	None.

Response Formats

application/json, text/json

Sample:

{
  "clientContactId": 1,
  "clientId": 1,
  "contactTypeId": 1,
  "contactTypeName": "sample string 1",
  "name": "sample string 2",
  "address1": "sample string 3",
  "city": "sample string 4",
  "stateAbbreviation": "sample string 5",
  "zipCode": "sample string 6",
  "phone": "sample string 7",
  "phoneAlternative": "sample string 8",
  "phoneMobile": "sample string 9",
  "email": "sample string 10",
  "relationship": "sample string 11",
  "externalId": "sample string 12",
  "clientVisitId": 1,
  "visitMapGroup": 64,
  "isAbleToReleaseInformation": true,
  "dateReleasedInfoExpires": "2026-05-07T23:24:20.7682484-04:00",
  "updatedByEmployeeId": 1,
  "dateReleasedInfoStarts": "2026-05-07T23:24:20.7682484-04:00",
  "notes": "sample string 13",
  "address2": "sample string 14",
  "agencyId": 1,
  "agencyName": "sample string 15",
  "source": "sample string 16",
  "isMobileVisitDestAddress": true,
  "dateCreated": "2026-05-07T23:24:20.7682484-04:00",
  "dateUpdated": "2026-05-07T23:24:20.7682484-04:00",
  "state": "New",
  "date": "2026-05-07T23:24:20.7682484-04:00"
}

application/xml, text/xml

Sample:

<UIClientContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CWI.Mobile.Domain.DTO">
  <dateCreated>2026-05-07T23:24:20.7682484-04:00</dateCreated>
  <dateUpdated>2026-05-07T23:24:20.7682484-04:00</dateUpdated>
  <address1>sample string 3</address1>
  <address2>sample string 14</address2>
  <agencyId>1</agencyId>
  <agencyName>sample string 15</agencyName>
  <city>sample string 4</city>
  <clientContactId>1</clientContactId>
  <clientId>1</clientId>
  <clientVisitId>1</clientVisitId>
  <contactTypeId>1</contactTypeId>
  <contactTypeName>sample string 1</contactTypeName>
  <dateReleasedInfoExpires>2026-05-07T23:24:20.7682484-04:00</dateReleasedInfoExpires>
  <dateReleasedInfoStarts>2026-05-07T23:24:20.7682484-04:00</dateReleasedInfoStarts>
  <email>sample string 10</email>
  <externalId>sample string 12</externalId>
  <isAbleToReleaseInformation>true</isAbleToReleaseInformation>
  <isMobileVisitDestAddress>true</isMobileVisitDestAddress>
  <name>sample string 2</name>
  <notes>sample string 13</notes>
  <phone>sample string 7</phone>
  <phoneAlternative>sample string 8</phoneAlternative>
  <phoneMobile>sample string 9</phoneMobile>
  <relationship>sample string 11</relationship>
  <source>sample string 16</source>
  <stateAbbreviation>sample string 5</stateAbbreviation>
  <updatedByEmployeeId>1</updatedByEmployeeId>
  <visitMapGroup>64</visitMapGroup>
  <zipCode>sample string 6</zipCode>
</UIClientContact>