POST api/compass/accounts/{accountId}/clients

Request Information

URI Parameters

Name	Description	Type	Additional information
accountId		string	Required

Body Parameters

CreateClientRequest

Name	Type	Additional information
Id	string	Required
PersonInfo	PersonInfoDto	Required
ContactInfo	ContactInfoDto	Required
Archived	boolean	Required

Request Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "PersonInfo": {
    "Name": {
      "Prefix": "sample string 1",
      "FirstName": "sample string 2",
      "MiddleName": "sample string 3",
      "LastName": "sample string 4",
      "Credentials": "sample string 5"
    },
    "Gender": "Male",
    "DateOfBirth": "2024-11-03T12:31:36.8306183+00:00",
    "Guardian": "sample string 1",
    "ReferredBy": "sample string 2",
    "Notes": "sample string 3"
  },
  "ContactInfo": {
    "Phone1": "sample string 1",
    "Phone2": "sample string 2",
    "Fax": "sample string 3",
    "Email": "sample string 4",
    "BillingAddress": {
      "Line1": "sample string 1",
      "Line2": "sample string 2",
      "City": "sample string 3",
      "PostalCode": "sample string 4",
      "Province": "sample string 5",
      "Country": "sample string 6"
    },
    "ShippingAddress": {
      "Line1": "sample string 1",
      "Line2": "sample string 2",
      "City": "sample string 3",
      "PostalCode": "sample string 4",
      "Province": "sample string 5",
      "Country": "sample string 6"
    }
  },
  "Archived": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.