PUT api/v2/Agents/{agentId}/Users/{contactId}

Create Contact

Request Information

Parameters

NameDescriptionAdditional information
payload

Define this parameter in the request body.

agentId

Define this parameter in the request URI.

contactId

Define this parameter in the request URI.

Request body formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "Password": "sample string 1",
  "ConfirmPassword": "sample string 2",
  "IsChangingPassword": true,
  "ContactID": 4,
  "AgentID": 5,
  "FirstName": "sample string 6",
  "LastName": "sample string 7",
  "Email": "sample string 8",
  "JobTitle": "sample string 9",
  "ContactNumber": "sample string 10",
  "IsActivated": true,
  "OperatedBy": 1,
  "AddressBookID": 1,
  "Permissions": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "ContactType": "sample string 12",
  "UCTReferer": "sample string 13",
  "UCTIsCaptcha": true,
  "UATReferer": "sample string 15",
  "UATIsCaptcha": true,
  "Username": "sample string 17",
  "GDPRflag": true
}

application/xml, text/xml

Sample:
<AgentContactSaveDTO>
  <ContactID>4</ContactID>
  <AgentID>5</AgentID>
  <FirstName>sample string 6</FirstName>
  <LastName>sample string 7</LastName>
  <Email>sample string 8</Email>
  <JobTitle>sample string 9</JobTitle>
  <ContactNumber>sample string 10</ContactNumber>
  <IsActivated>true</IsActivated>
  <OperatedBy>1</OperatedBy>
  <AddressBookID>1</AddressBookID>
  <Permissions>sample string 1</Permissions>
  <Permissions>sample string 2</Permissions>
  <Permissions>sample string 3</Permissions>
  <ContactType>sample string 12</ContactType>
  <UCTReferer>sample string 13</UCTReferer>
  <UCTIsCaptcha>true</UCTIsCaptcha>
  <UATReferer>sample string 15</UATReferer>
  <UATIsCaptcha>true</UATIsCaptcha>
  <Username>sample string 17</Username>
  <GDPRflag>true</GDPRflag>
  <Password>sample string 1</Password>
  <ConfirmPassword>sample string 2</ConfirmPassword>
  <IsChangingPassword>true</IsChangingPassword>
</AgentContactSaveDTO>

Response Information

Response body formats

application/json, text/json

Sample:
{
  "ContactID": 1,
  "AgentID": 2,
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "Email": "sample string 5",
  "JobTitle": "sample string 6",
  "ContactNumber": "sample string 7",
  "IsActivated": true,
  "OperatedBy": 1,
  "AddressBookID": 1,
  "Permissions": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "ContactType": "sample string 9",
  "UCTReferer": "sample string 10",
  "UCTIsCaptcha": true,
  "UATReferer": "sample string 12",
  "UATIsCaptcha": true,
  "Username": "sample string 14",
  "GDPRflag": true
}

application/xml, text/xml

Sample:
<AgentContactDTO>
  <ContactID>1</ContactID>
  <AgentID>2</AgentID>
  <FirstName>sample string 3</FirstName>
  <LastName>sample string 4</LastName>
  <Email>sample string 5</Email>
  <JobTitle>sample string 6</JobTitle>
  <ContactNumber>sample string 7</ContactNumber>
  <IsActivated>true</IsActivated>
  <OperatedBy>1</OperatedBy>
  <AddressBookID>1</AddressBookID>
  <Permissions>sample string 1</Permissions>
  <Permissions>sample string 2</Permissions>
  <Permissions>sample string 3</Permissions>
  <ContactType>sample string 9</ContactType>
  <UCTReferer>sample string 10</UCTReferer>
  <UCTIsCaptcha>true</UCTIsCaptcha>
  <UATReferer>sample string 12</UATReferer>
  <UATIsCaptcha>true</UATIsCaptcha>
  <Username>sample string 14</Username>
  <GDPRflag>true</GDPRflag>
</AgentContactDTO>