POST api/branch/updatebranch/{orgKey}/{companyKey}/{branchKey}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
branchKey

integer

Required

companyKey

integer

Required

orgKey

integer

Required

Body Parameters

BranchModel
NameDescriptionTypeAdditional information
CompanyKey

integer

None.

OrgKey

integer

None.

BranchKey

integer

None.

BranchCode

string

None.

BranchName

string

None.

CompanyName

string

None.

BranchTimeZone

string

None.

Productlines

ProductLineModel

None.

ProductLinesArray

Collection of ProductLineModel

None.

Name

string

None.

ContactPhoneNumber

string

None.

LogoURI

string

None.

LogoFileName

string

None.

AlternateEmail

string

None.

Email

string

None.

TemplateKey

integer

None.

SiteTemplate

SiteTemplateModel

None.

Address

AddressModel

None.

Emails

Collection of ContactEmailModel

None.

Request Formats

application/json, text/json

Sample:
{
  "siteTemplate": {
    "templateKey": 1,
    "templateHeadingColor": "sample string 2",
    "templateSidebarColor": "sample string 3",
    "templateTextColor": "sample string 4"
  },
  "address": {
    "address1": "sample string 1",
    "address2": "sample string 2",
    "addressCity": "sample string 3",
    "addressState": "sample string 4",
    "addressZipCode": "sample string 5"
  },
  "emails": [
    {
      "userKey": 1,
      "emailType": "sample string 1",
      "emailTypeKey": 64,
      "contactEmailAddress": "sample string 3",
      "contactEmailKey": 4,
      "contactKey": 5
    },
    {
      "userKey": 1,
      "emailType": "sample string 1",
      "emailTypeKey": 64,
      "contactEmailAddress": "sample string 3",
      "contactEmailKey": 4,
      "contactKey": 5
    }
  ],
  "companyKey": 1,
  "orgKey": 2,
  "branchKey": 3,
  "branchCode": "sample string 4",
  "branchName": "sample string 5",
  "companyName": "sample string 6",
  "branchTimeZone": "sample string 7",
  "productlines": {
    "productlineKey": 1,
    "productlineName": "sample string 2",
    "productlineshortName": "sample string 3"
  },
  "productLinesArray": [
    {
      "productlineKey": 1,
      "productlineName": "sample string 2",
      "productlineshortName": "sample string 3"
    },
    {
      "productlineKey": 1,
      "productlineName": "sample string 2",
      "productlineshortName": "sample string 3"
    }
  ],
  "name": "sample string 8",
  "contactPhoneNumber": "sample string 9",
  "logoURI": "sample string 10",
  "logoFileName": "sample string 11",
  "alternateEmail": "sample string 12",
  "email": "sample string 13",
  "templateKey": 1
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PageViewModel
NameDescriptionTypeAdditional information
StatusCode

integer

None.

StatusMessage

string

None.

TotalCount

integer

None.

ModelObject

Object

None.

CurrentDateTime

date

None.

Response Formats

application/json, text/json

Sample:
{
  "statusCode": 1,
  "statusMessage": "sample string 2",
  "totalCount": 3,
  "modelObject": {},
  "currentDateTime": "2026-01-29T20:40:44.1261284+00:00"
}