PUT v1/account/{id}

Update the account for the authenticated user

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
id

Account Kapta ID

string

Required.

Body Parameters

Information about the account

UpdateAccountModel
NameDescriptionTypeAdditional Information
ID

The Account's unique identifier (Kapta)

string

Required.

Name

Account Name

string

None.

Description

Description or notes about the account

string

None.

Website

Website of the account

string

None.

BudgetDate

The fiscal year end or budget date of the account

date

None.

CustomFields

Custom Field List (if they have been defined)

Collection of UDFFieldModel

None.

Request Formats

application/json, text/json, text/html

Sample:
{
  "ID": "sample string 1",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "Website": "sample string 4",
  "BudgetDate": "2025-05-24T11:37:09.4478405+00:00",
  "CustomFields": [
    {
      "FieldName": "sample string 1",
      "Type": "sample string 2",
      "StringValue": "sample string 3",
      "DoubleValue": 4.1,
      "DatetimeValue": "2025-05-24T11:37:09.4478405+00:00"
    },
    {
      "FieldName": "sample string 1",
      "Type": "sample string 2",
      "StringValue": "sample string 3",
      "DoubleValue": 4.1,
      "DatetimeValue": "2025-05-24T11:37:09.4478405+00:00"
    }
  ]
}

application/xml, text/xml

Sample:
<UpdateAccountModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KAPTA.Domain.ViewModel.v1">
  <BudgetDate>2025-05-24T11:37:09.4478405+00:00</BudgetDate>
  <CustomFields>
    <UDFFieldModel>
      <DatetimeValue>2025-05-24T11:37:09.4478405+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-24T11:37:09.4478405+00:00</DatetimeValue>
      <DoubleValue>4.1</DoubleValue>
      <FieldName>sample string 1</FieldName>
      <StringValue>sample string 3</StringValue>
      <Type>sample string 2</Type>
    </UDFFieldModel>
  </CustomFields>
  <Description>sample string 3</Description>
  <ID>sample string 1</ID>
  <Name>sample string 2</Name>
  <Website>sample string 4</Website>
</UpdateAccountModel>

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-24T11:37:09.4478405+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-24T11:37:09.4478405+00:00"
    },
    {
      "FieldName": "sample string 1",
      "Type": "sample string 2",
      "StringValue": "sample string 3",
      "DoubleValue": 4.1,
      "DatetimeValue": "2025-05-24T11:37:09.4478405+00:00"
    }
  ],
  "DateModified": "2025-05-24T11:37:09.4478405+00:00",
  "DateCreated": "2025-05-24T11:37:09.4478405+00:00",
  "AppUrl": "sample string 12",
  "ImageUrl": "sample string 13",
  "FreshnessDate": "2025-05-24T11:37:09.4478405+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-24T11:37:09.4478405+00:00</BudgetDate>
  <CRMID>sample string 2</CRMID>
  <CustomFields>
    <UDFFieldModel>
      <DatetimeValue>2025-05-24T11:37:09.4478405+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-24T11:37:09.4478405+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-24T11:37:09.4478405+00:00</DateCreated>
  <DateModified>2025-05-24T11:37:09.4478405+00:00</DateModified>
  <Description>sample string 4</Description>
  <FreshnessDate>2025-05-24T11:37:09.4478405+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>