POST v1/account

Creates a new account for the authenticated user

Request Information

URI Parameters

None.

Body Parameters

Information about a new account

NewAccountModel
NameDescriptionTypeAdditional Information
Name

The account's name

string

Required.

Description

The account's description, which contains notes or important details about this account

string

None.

Website

The company's website.

string

None.

BudgetDate

The fiscal year end or budget date of the account

date

None.

Owner

The account owner, should be the email address of valid user. If left blank the authorized users will be used.

string

None.

Request Formats

application/json, text/json, text/html

Sample:
{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "Website": "sample string 3",
  "BudgetDate": "2025-05-24T10:09:00.0691063+00:00",
  "Owner": "sample string 4"
}

application/xml, text/xml

Sample:
<NewAccountModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KAPTA.Domain.ViewModel.v1">
  <BudgetDate>2025-05-24T10:09:00.0691063+00:00</BudgetDate>
  <Description>sample string 2</Description>
  <Name>sample string 1</Name>
  <Owner>sample string 4</Owner>
  <Website>sample string 3</Website>
</NewAccountModel>

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html

Sample:
{
  "ID": "sample string 1",
  "CRMID": "sample string 2",
  "Name": "sample string 3",
  "Description": "sample string 4",
  "Website": "sample string 5",
  "Type": "sample string 6",
  "ParentAccountID": "sample string 7",
  "BudgetDate": "2025-05-24T10:09:00.0691063+00:00",
  "HealthScore": 8.1,
  "Value": 9.1,
  "Owner": {
    "ID": "sample string 1",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "Email": "sample string 4"
  },
  "CustomFields": [
    {
      "FieldName": "sample string 1",
      "Type": "sample string 2",
      "StringValue": "sample string 3",
      "DoubleValue": 4.1,
      "DatetimeValue": "2025-05-24T10:09:00.0691063+00:00"
    },
    {
      "FieldName": "sample string 1",
      "Type": "sample string 2",
      "StringValue": "sample string 3",
      "DoubleValue": 4.1,
      "DatetimeValue": "2025-05-24T10:09:00.0691063+00:00"
    }
  ],
  "DateModified": "2025-05-24T10:09:00.0691063+00:00",
  "DateCreated": "2025-05-24T10:09:00.0691063+00:00",
  "AppUrl": "sample string 12",
  "ImageUrl": "sample string 13",
  "FreshnessDate": "2025-05-24T10:09:00.0691063+00:00"
}

application/xml, text/xml

Sample:
<AccountModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KAPTA.Domain.ViewModel.v1">
  <AppUrl>sample string 12</AppUrl>
  <BudgetDate>2025-05-24T10:09:00.0691063+00:00</BudgetDate>
  <CRMID>sample string 2</CRMID>
  <CustomFields>
    <UDFFieldModel>
      <DatetimeValue>2025-05-24T10:09:00.0691063+00:00</DatetimeValue>
      <DoubleValue>4.1</DoubleValue>
      <FieldName>sample string 1</FieldName>
      <StringValue>sample string 3</StringValue>
      <Type>sample string 2</Type>
    </UDFFieldModel>
    <UDFFieldModel>
      <DatetimeValue>2025-05-24T10:09:00.0691063+00:00</DatetimeValue>
      <DoubleValue>4.1</DoubleValue>
      <FieldName>sample string 1</FieldName>
      <StringValue>sample string 3</StringValue>
      <Type>sample string 2</Type>
    </UDFFieldModel>
  </CustomFields>
  <DateCreated>2025-05-24T10:09:00.0691063+00:00</DateCreated>
  <DateModified>2025-05-24T10:09:00.0691063+00:00</DateModified>
  <Description>sample string 4</Description>
  <FreshnessDate>2025-05-24T10:09:00.0691063+00:00</FreshnessDate>
  <HealthScore>8.1</HealthScore>
  <ID>sample string 1</ID>
  <ImageUrl>sample string 13</ImageUrl>
  <Name>sample string 3</Name>
  <Owner>
    <Email>sample string 4</Email>
    <FirstName>sample string 2</FirstName>
    <ID>sample string 1</ID>
    <LastName>sample string 3</LastName>
  </Owner>
  <ParentAccountID>sample string 7</ParentAccountID>
  <Type>sample string 6</Type>
  <Value>9.1</Value>
  <Website>sample string 5</Website>
</AccountModel>