PUT Agency/Update/{agencyId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
agencyId

string

Required

Body Parameters

Magnesium.Insurance.Contracts.AgencyAdmin.AgencyUpdateRequest
NameDescriptionTypeAdditional information
AgencyId

globally unique identifier

None.

Profile

Magnesium.Insurance.Contracts.AgencyAdmin.AgencyProfileUpdate

None.

Address

Magnesium.Insurance.Contracts.AgencyAdmin.AgencyAddress

None.

Request Formats

application/json, text/json, text/html

Sample:
{
  "AgencyId": "85d81dae-7b3b-4cd7-89cb-229707643ec2",
  "Profile": {
    "AgencyCode": "sample string 1",
    "CreateDate": "2023-06-09T00:35:29.2083641-04:00",
    "AgencyName": "sample string 3",
    "MainChannel": "sample string 4",
    "ParentAccount": {
      "Id": "17f5e9ff-92f3-475e-8b28-64ab28d46094",
      "AgencyName": "sample string 2"
    },
    "Language": "sample string 5",
    "Bdm": null,
    "HomeProvince": "sample string 6",
    "PartnerURL": "sample string 7",
    "AgreementDate": "2023-06-09T00:35:29.2083641-04:00",
    "EffectiveDate": "2023-06-09T00:35:29.2083641-04:00",
    "TerminationDate": "2023-06-09T00:35:29.2093646-04:00",
    "BillToTop": true,
    "AllowAgencyBilled": true,
    "EnableB2CSite": true,
    "SponsoredLicense": true
  },
  "Address": {
    "AgencyId": "272802ec-3787-461c-badf-6181e63d6020",
    "BillingAddress1": "sample string 2",
    "BillingAddress2": "sample string 3",
    "BillingProvince": "sample string 4",
    "BillingCity": "sample string 5",
    "BillingPostalCode": "sample string 6",
    "BillingCountry": "sample string 7",
    "BillingEmail": "sample string 8",
    "BillingPhone": "sample string 9",
    "BillingIsEqual": true,
    "BusinessAddress1": "sample string 10",
    "BusinessAddress2": "sample string 11",
    "BusinessProvince": "sample string 12",
    "BusinessCity": "sample string 13",
    "BusinessPostalCode": "sample string 14",
    "BusinessCountry": "sample string 15",
    "BusinessEmail": "sample string 16",
    "BusinessPhone": "sample string 17",
    "ContactName": "sample string 18",
    "ContactEmail": "sample string 19"
  }
}

Response Information

Resource Description

Magnesium.Insurance.Contracts.AgencyAdmin.Result
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

UserMessage

string

None.

Errors

Collection of string

None.

Response Formats

application/json, text/json, text/html

Sample:
{
  "Id": "2d230f2d-66ed-4509-924e-a90ffc581c97",
  "UserMessage": "sample string 2",
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}