POST api/persons

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Profile	PersonProfileCreationRequest	None.
Contacts	Collection of PersonContactCreationRequest	None.
Addresses	Collection of PersonAddressCreationRequest	None.
Notes	Collection of PersonNoteCreationRequest	None.
LoginCredentials	AuthenticationCredentials	None.

Request Formats

application/json, text/json

Sample:

{
  "Profile": {
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "Names": [
      {
        "Type": 0,
        "LocaleID": 1,
        "EntityContextID": 1,
        "Name": "sample string 2",
        "SortOrder": 3
      },
      {
        "Type": 0,
        "LocaleID": 1,
        "EntityContextID": 1,
        "Name": "sample string 2",
        "SortOrder": 3
      }
    ],
    "Gender": 0,
    "dtBirthday": "2025-12-06T13:24:18.2748727+00:00",
    "PersonalCode": "sample string 3",
    "PersonalCodeCategory": 0,
    "Preferences": {
      "PreferredClientTerritoryID": 1,
      "PreferredLanguageID": 1,
      "TermsOfServiceKeywords": [
        {
          "KeywordID": 1,
          "Choice": 0
        },
        {
          "KeywordID": 1,
          "Choice": 0
        }
      ],
      "LegalConsentKeywords": [
        {
          "KeywordID": 1,
          "Choice": 0
        },
        {
          "KeywordID": 1,
          "Choice": 0
        }
      ],
      "MarketingKeywords": [
        {
          "KeywordID": 1,
          "Choice": 0
        },
        {
          "KeywordID": 1,
          "Choice": 0
        }
      ]
    }
  },
  "Contacts": [
    {
      "TypeID": 2,
      "Alias": "sample string 3",
      "Contact": "sample string 4",
      "IsPublic": true,
      "IsPrimary": true
    },
    {
      "TypeID": 2,
      "Alias": "sample string 3",
      "Contact": "sample string 4",
      "IsPublic": true,
      "IsPrimary": true
    }
  ],
  "Addresses": [
    {
      "Alias": "sample string 2",
      "ContactName": "sample string 3",
      "ContactEmail": "sample string 4",
      "ContactPhone": "sample string 5",
      "AddressLine1": "sample string 6",
      "AddressLine2": "sample string 7",
      "City": "sample string 8",
      "CityDistrict": "sample string 9",
      "PostalCode": "sample string 10",
      "Region": "sample string 11",
      "CountryID": 12,
      "IsPublic": true,
      "Types": [
        {
          "AddressType": 0,
          "IsPrimary": true
        },
        {
          "AddressType": 0,
          "IsPrimary": true
        }
      ]
    },
    {
      "Alias": "sample string 2",
      "ContactName": "sample string 3",
      "ContactEmail": "sample string 4",
      "ContactPhone": "sample string 5",
      "AddressLine1": "sample string 6",
      "AddressLine2": "sample string 7",
      "City": "sample string 8",
      "CityDistrict": "sample string 9",
      "PostalCode": "sample string 10",
      "Region": "sample string 11",
      "CountryID": 12,
      "IsPublic": true,
      "Types": [
        {
          "AddressType": 0,
          "IsPrimary": true
        },
        {
          "AddressType": 0,
          "IsPrimary": true
        }
      ]
    }
  ],
  "Notes": [
    {
      "Type": 0,
      "Notes": "sample string 2"
    },
    {
      "Type": 0,
      "Notes": "sample string 2"
    }
  ],
  "LoginCredentials": {
    "UserID": "sample string 1",
    "UserSecret": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<PersonCreationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Addresses>
    <PersonAddressCreationRequest>
      <AddressLine1>sample string 6</AddressLine1>
      <AddressLine2>sample string 7</AddressLine2>
      <Alias>sample string 2</Alias>
      <City>sample string 8</City>
      <CityDistrict>sample string 9</CityDistrict>
      <ContactEmail>sample string 4</ContactEmail>
      <ContactName>sample string 3</ContactName>
      <ContactPhone>sample string 5</ContactPhone>
      <CountryID>12</CountryID>
      <IsPublic>true</IsPublic>
      <PostalCode>sample string 10</PostalCode>
      <Region>sample string 11</Region>
      <Types>
        <PersonAddressRequestAddressTypes>
          <AddressType>Unknown</AddressType>
          <IsPrimary>true</IsPrimary>
        </PersonAddressRequestAddressTypes>
        <PersonAddressRequestAddressTypes>
          <AddressType>Unknown</AddressType>
          <IsPrimary>true</IsPrimary>
        </PersonAddressRequestAddressTypes>
      </Types>
    </PersonAddressCreationRequest>
    <PersonAddressCreationRequest>
      <AddressLine1>sample string 6</AddressLine1>
      <AddressLine2>sample string 7</AddressLine2>
      <Alias>sample string 2</Alias>
      <City>sample string 8</City>
      <CityDistrict>sample string 9</CityDistrict>
      <ContactEmail>sample string 4</ContactEmail>
      <ContactName>sample string 3</ContactName>
      <ContactPhone>sample string 5</ContactPhone>
      <CountryID>12</CountryID>
      <IsPublic>true</IsPublic>
      <PostalCode>sample string 10</PostalCode>
      <Region>sample string 11</Region>
      <Types>
        <PersonAddressRequestAddressTypes>
          <AddressType>Unknown</AddressType>
          <IsPrimary>true</IsPrimary>
        </PersonAddressRequestAddressTypes>
        <PersonAddressRequestAddressTypes>
          <AddressType>Unknown</AddressType>
          <IsPrimary>true</IsPrimary>
        </PersonAddressRequestAddressTypes>
      </Types>
    </PersonAddressCreationRequest>
  </Addresses>
  <Contacts>
    <PersonContactCreationRequest>
      <Alias>sample string 3</Alias>
      <Contact>sample string 4</Contact>
      <IsPrimary>true</IsPrimary>
      <IsPublic>true</IsPublic>
      <TypeID>2</TypeID>
    </PersonContactCreationRequest>
    <PersonContactCreationRequest>
      <Alias>sample string 3</Alias>
      <Contact>sample string 4</Contact>
      <IsPrimary>true</IsPrimary>
      <IsPublic>true</IsPublic>
      <TypeID>2</TypeID>
    </PersonContactCreationRequest>
  </Contacts>
  <LoginCredentials>
    <UserID>sample string 1</UserID>
    <UserSecret>sample string 2</UserSecret>
  </LoginCredentials>
  <Notes>
    <PersonNoteCreationRequest>
      <Notes>sample string 2</Notes>
      <Type>Unknown</Type>
    </PersonNoteCreationRequest>
    <PersonNoteCreationRequest>
      <Notes>sample string 2</Notes>
      <Type>Unknown</Type>
    </PersonNoteCreationRequest>
  </Notes>
  <Profile>
    <FirstName>sample string 1</FirstName>
    <Gender>Undefined</Gender>
    <LastName>sample string 2</LastName>
    <Names>
      <PersonNameCreationRequest>
        <EntityContextID>1</EntityContextID>
        <LocaleID>1</LocaleID>
        <Name>sample string 2</Name>
        <SortOrder>3</SortOrder>
        <Type>Unknown</Type>
      </PersonNameCreationRequest>
      <PersonNameCreationRequest>
        <EntityContextID>1</EntityContextID>
        <LocaleID>1</LocaleID>
        <Name>sample string 2</Name>
        <SortOrder>3</SortOrder>
        <Type>Unknown</Type>
      </PersonNameCreationRequest>
    </Names>
    <PersonalCode>sample string 3</PersonalCode>
    <PersonalCodeCategory>Unknown</PersonalCodeCategory>
    <Preferences>
      <LegalConsentKeywords>
        <KeywordSelection>
          <Choice>Unknown</Choice>
          <KeywordID>1</KeywordID>
        </KeywordSelection>
        <KeywordSelection>
          <Choice>Unknown</Choice>
          <KeywordID>1</KeywordID>
        </KeywordSelection>
      </LegalConsentKeywords>
      <MarketingKeywords>
        <KeywordSelection>
          <Choice>Unknown</Choice>
          <KeywordID>1</KeywordID>
        </KeywordSelection>
        <KeywordSelection>
          <Choice>Unknown</Choice>
          <KeywordID>1</KeywordID>
        </KeywordSelection>
      </MarketingKeywords>
      <PreferredClientTerritoryID>1</PreferredClientTerritoryID>
      <PreferredLanguageID>1</PreferredLanguageID>
      <TermsOfServiceKeywords>
        <KeywordSelection>
          <Choice>Unknown</Choice>
          <KeywordID>1</KeywordID>
        </KeywordSelection>
        <KeywordSelection>
          <Choice>Unknown</Choice>
          <KeywordID>1</KeywordID>
        </KeywordSelection>
      </TermsOfServiceKeywords>
    </Preferences>
    <dtBirthday>2025-12-06T13:24:18.2748727+00:00</dtBirthday>
  </Profile>
</PersonCreationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.