Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

updateShare

Perform various update operations on share records.

Symitar eDocs References: Coming soon.

Operations

updateShareByID

post
Authorizations
Body
AccountNumberstringOptional
ShareIdstringOptional
Responses
200

Successful operation.

application/json
post/updateShareByID
POST /nexum/627/persistent/account/updateShareByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 250

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000017368",
  "ShareId": "0100",
  "ShareFields": {
    "Description": "NEXUM W4 SHARE UPD",
    "UserChar1": "W4S"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": null,
    "Version_1": null,
    "_value_1": null
  },
  "MessageId": "updateShareByID"
}

updateShareAnalysisByID

post
Authorizations
Body
AccountNumberstringOptional
ShareIdstringOptional
ShareAnalysisLocatorintegerOptional
Responses
200

Successful operation.

application/json
post/updateShareAnalysisByID
POST /nexum/627/persistent/account/updateShareAnalysisByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 266

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000017368",
  "ShareId": "0100",
  "ShareAnalysisLocator": 7,
  "ShareAnalysisFields": {
    "CashAmtTotal": 1,
    "StatementGroup": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": null,
    "Version_1": null,
    "_value_1": null
  },
  "MessageId": "updateShareAnalysisByID"
}

updateShareAnalysisGroupByID

post
Authorizations
Body
AccountNumberstringOptional
ShareIdstringOptional
ShareAnalysisGroupLocatorintegerOptional
Responses
200

Successful operation.

application/json
post/updateShareAnalysisGroupByID
POST /nexum/627/persistent/account/updateShareAnalysisGroupByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 266

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000017368",
  "ShareId": "0100",
  "ShareAnalysisGroupLocator": 8,
  "ShareAnalysisGroupFields": {
    "Comment1": "NEXUM W4 UPD"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": null,
    "Version_1": null,
    "_value_1": null
  },
  "MessageId": "updateShareAnalysisGroupByID"
}

updateShareAnalysisPlanByID

post
Authorizations
Body
AccountNumberstringOptional
ShareIdstringOptional
ShareAnalysisPlanLocatorintegerOptional
Responses
200

Successful operation.

application/json
post/updateShareAnalysisPlanByID
POST /nexum/627/persistent/account/updateShareAnalysisPlanByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 288

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000017368",
  "ShareId": "0100",
  "ShareAnalysisPlanLocator": 6,
  "ShareAnalysisPlanFields": {
    "Description": "NEXUM W4 PLAN UPD",
    "DefinedCode": 1
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": null,
    "Version_1": null,
    "_value_1": null
  },
  "MessageId": "updateShareAnalysisPlanByID"
}

updateShareCheckOrderByID

post
Authorizations
Body
AccountNumberstringOptional
ShareIdstringOptional
ShareCheckOrderLocatorintegerOptional
Responses
200

Successful operation.

application/json
post/updateShareCheckOrderByID
POST /nexum/627/persistent/account/updateShareCheckOrderByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 259

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000017368",
  "ShareId": "0100",
  "ShareCheckOrderLocator": 9,
  "ShareCheckOrderFields": {
    "Quantity": 30,
    "Status": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": null,
    "Version_1": null,
    "_value_1": null
  },
  "MessageId": "updateShareCheckOrderByID"
}

updateShareHoldByID

post
Authorizations
Body
AccountNumberstringOptional
ShareIdstringOptional
ShareHoldLocatorintegerOptional
Responses
200

Successful operation.

application/json
post/updateShareHoldByID
POST /nexum/627/persistent/account/updateShareHoldByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000017368",
  "ShareId": "0100",
  "ShareHoldLocator": 4,
  "ShareHoldFields": {
    "Amount": 2,
    "Reference1": "NXW4UPD"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": null,
    "Version_1": null,
    "_value_1": null
  },
  "MessageId": "updateShareHoldByID"
}

updateShareNoteByID

post
Authorizations
Body
AccountNumberstringOptional
ShareIdstringOptional
ShareNoteLocatorintegerOptional
Responses
200

Successful operation.

application/json
post/updateShareNoteByID
POST /nexum/627/persistent/account/updateShareNoteByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 282

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000017368",
  "ShareId": "0100",
  "ShareNoteLocator": 3,
  "ShareNoteFields": {
    "Text": [
      {
        "EntryId": 1,
        "Text": "NEXUM W4 SHARE NOTE UPDATED"
      }
    ]
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": null,
    "Version_1": null,
    "_value_1": null
  },
  "MessageId": "updateShareNoteByID"
}

updateShareTransferByID

post
Authorizations
Body
AccountNumberstringOptional
ShareIdstringOptional
ShareTransferLocatorintegerOptional
Responses
200

Successful operation.

application/json
post/updateShareTransferByID
POST /nexum/627/persistent/account/updateShareTransferByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 255

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000017368",
  "ShareId": "0100",
  "ShareTransferLocator": 5,
  "ShareTransferFields": {
    "PaymentType": 0,
    "RegE": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": null,
    "Version_1": null,
    "_value_1": null
  },
  "MessageId": "updateShareTransferByID"
}

updateShareNameByID

post
Authorizations
Body
AccountNumberstringOptional
ShareIdstringOptional
ShareNameLocatorintegerOptional
Responses
200

Successful operation.

application/json
post/updateShareNameByID
POST /nexum/627/persistent/account/updateShareNameByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 3736

{
  "Credentials": {
    "AccountNumberCredentials": {},
    "HomeBankingCredentials": {},
    "CardCredentials": {},
    "MICRCredentials": {},
    "LookupCredentials": {},
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "AccountNumber": "text",
  "ShareId": "text",
  "ShareNameLocator": 1,
  "ShareNameFields": {
    "ActiveDuty": 1,
    "ActiveDutySeparationDate": "2026-01-01",
    "ActiveDutyStartDate": "2026-01-01",
    "ActiveDutyVerificationDate": "2026-01-01",
    "AddrCreateDate": "2026-01-01",
    "AddrDisconnectDate": "2026-01-01",
    "AddrExpDate": "2026-01-01",
    "AddrFmLastDate": "2026-01-01",
    "AddrFmLastPurgeDate": "2026-01-01",
    "AddrRecordChangeDate": "2026-01-01",
    "AddressType": 1,
    "AltEmail": "text",
    "BeneficialOwner": 1,
    "BeneficialPercent": 1,
    "BeneficiaryPercent": 1,
    "BirthDate": "2026-01-01",
    "CarrierRoute": "text",
    "Chapter4StatusCode": "text",
    "City": "text",
    "Confidential": 1,
    "Country": "text",
    "CountryCode": "text",
    "CrAddrChgDate": "2026-01-01",
    "CrNameChgDate": "2026-01-01",
    "CrSsnChgDate": "2026-01-01",
    "CreditReportAddrIndicator": "text",
    "CreditReportAddrIndicatorDate": "2026-01-01",
    "CreditReportConsumerInfo": "text",
    "CreditReportConsumerInfoDate": "2026-01-01",
    "CtrExempt": 1,
    "CurrGrossMonthPay": 1,
    "CurrMonthPayChgDate": "2026-01-01",
    "CurrNetMonthPay": 1,
    "DbaExtendedName": "text",
    "DbaFirst": "text",
    "DbaLast": "text",
    "DbaLongName": "text",
    "DbaMiddle": "text",
    "DbaNameFormat": 1,
    "DbaShortName": "text",
    "DbaSuffix": "text",
    "DbaTitle": "text",
    "DeathDate": "2026-01-01",
    "EcoaCode": 1,
    "EffectiveDate": "2026-01-01",
    "Email": "text",
    "EmployerName": "text",
    "ExpirationDate": "2026-01-01",
    "ExtendedName": "text",
    "ExtraAddress": "text",
    "ExtraInfo": "text",
    "First": "text",
    "FmLastPurgeDate": "2026-01-01",
    "ForeignTin": "text",
    "FormW8OnFile": 1,
    "GIin": "text",
    "Headquarters": 1,
    "HomePhone": "text",
    "IdentDocFlag": [
      {
        "EntryId": 1,
        "IdentDocFlag": 1
      }
    ],
    "IdentIdDescription": [
      {
        "EntryId": 1,
        "IdentIdDescription": "text"
      }
    ],
    "IdentIdExpireDate": [
      {
        "EntryId": 1,
        "IdentIdExpireDate": "2026-01-01"
      }
    ],
    "IdentIdIssueDate": [
      {
        "EntryId": 1,
        "IdentIdIssueDate": "2026-01-01"
      }
    ],
    "IdentIdNumber": [
      {
        "EntryId": 1,
        "IdentIdNumber": "text"
      }
    ],
    "IdentIdType": [
      {
        "EntryId": 1,
        "IdentIdType": 1
      }
    ],
    "IdentIdVerifyDate": [
      {
        "EntryId": 1,
        "IdentIdVerifyDate": "2026-01-01"
      }
    ],
    "Irs1042SAmendNum": 1,
    "IrsCorrection": 1,
    "IrsCountryCode": "text",
    "Last": "text",
    "LastAddrChgDate": "2026-01-01",
    "LastAddrVerifDate": "2026-01-01",
    "LastFmDate": "2026-01-01",
    "Lei": "text",
    "License": "text",
    "Lob": "text",
    "Locator": 1,
    "LongName": "text",
    "MailOverride": 1,
    "MarketingAddress": 1,
    "MbrActivityDate": "2026-01-01",
    "MbrAddrFileType": 1,
    "MbrAddrNumLink": "text",
    "MbrAddrNumLinkChgDate": "2026-01-01",
    "MbrAddrNumber": "text",
    "MbrCreateDate": "2026-01-01",
    "MbrDisconnectDate": "2026-01-01",
    "MbrExpDate": "2026-01-01",
    "MbrFileType": 1,
    "MbrFmLastDate": "2026-01-01",
    "MbrFmLastPurgeDate": "2026-01-01",
    "MbrRecordChangeDate": "2026-01-01",
    "MbrStatus": 1,
    "MbrStatusFmDate": "2026-01-01",
    "MemberNumLink": "text",
    "MemberNumLinkChgDate": "2026-01-01",
    "MemberNumber": "text",
    "Middle": "text",
    "MobilePhone": "text",
    "MothersMaidenName": "text",
    "NameFormat": 1,
    "NonAcctNameNum": "text",
    "NraExemptionCode": "text",
    "NraTaxRate": 1,
    "Occupation": "text",
    "PagerNumber": "text",
    "PhoneType": 1,
    "PreferredContact": "text",
    "PreferredContactMethod": 1,
    "RecordChangeDate": "2026-01-01",
    "Restrict": 1,
    "Sex": "text",
    "ShortName": "text",
    "Ssn": "text",
    "SsnCertification": 1,
    "SsnOverride": 1,
    "SsnType": 1,
    "State": "text",
    "Street": "text",
    "SubType": 1,
    "SubstantialOwner": 1,
    "Suffix": "text",
    "Title": "text",
    "Type": 1,
    "UsPersonFlag": 1,
    "UserAmount1": 1,
    "UserAmount2": 1,
    "UserChar1": "text",
    "UserChar2": "text",
    "UserChar3": "text",
    "UserChar4": "text",
    "UserDate1": "2026-01-01",
    "UserDate2": "2026-01-01",
    "W8ExpirationDate": "2026-01-01",
    "WorkPhone": "text",
    "WorkPhoneExtension": "text",
    "ZipCode": "text"
  },
  "nxAttributes": {
    "customFields": {}
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": {
      "Record": "text",
      "ErrorCode": "text",
      "ErrorMessage": "text",
      "PrimaryKeyField": [
        {
          "Name": "text",
          "Value": "text"
        }
      ]
    }
  }
}

updateShareTrackingByID

post
Authorizations
Body
AccountNumberstringOptional
ShareIdstringOptional
ShareTrackingLocatorintegerOptional
Responses
200

Successful operation.

application/json
post/updateShareTrackingByID
POST /nexum/627/persistent/account/updateShareTrackingByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 2756

{
  "Credentials": {
    "AccountNumberCredentials": {},
    "HomeBankingCredentials": {},
    "CardCredentials": {},
    "MICRCredentials": {},
    "LookupCredentials": {},
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "AccountNumber": "text",
  "ShareId": "text",
  "ShareTrackingLocator": 1,
  "ShareTrackingFields": {
    "CreationDate": "2026-01-01",
    "CreationTime": 1,
    "ExpireDate": "2026-01-01",
    "FmLastDate": "2026-01-01",
    "Id": "text",
    "IdType": 1,
    "Locator": 1,
    "RecordChangeDate": "2026-01-01",
    "TrackingCode": 1,
    "Type": 1,
    "UserAmount1": 1,
    "UserAmount10": 1,
    "UserAmount11": 1,
    "UserAmount12": 1,
    "UserAmount13": 1,
    "UserAmount14": 1,
    "UserAmount15": 1,
    "UserAmount16": 1,
    "UserAmount17": 1,
    "UserAmount18": 1,
    "UserAmount19": 1,
    "UserAmount2": 1,
    "UserAmount20": 1,
    "UserAmount3": 1,
    "UserAmount4": 1,
    "UserAmount5": 1,
    "UserAmount6": 1,
    "UserAmount7": 1,
    "UserAmount8": 1,
    "UserAmount9": 1,
    "UserChar1": "text",
    "UserChar10": "text",
    "UserChar11": "text",
    "UserChar12": "text",
    "UserChar13": "text",
    "UserChar14": "text",
    "UserChar15": "text",
    "UserChar16": "text",
    "UserChar17": "text",
    "UserChar18": "text",
    "UserChar19": "text",
    "UserChar2": "text",
    "UserChar20": "text",
    "UserChar3": "text",
    "UserChar4": "text",
    "UserChar5": "text",
    "UserChar6": "text",
    "UserChar7": "text",
    "UserChar8": "text",
    "UserChar9": "text",
    "UserCode1": 1,
    "UserCode10": 1,
    "UserCode11": 1,
    "UserCode12": 1,
    "UserCode13": 1,
    "UserCode14": 1,
    "UserCode15": 1,
    "UserCode16": 1,
    "UserCode17": 1,
    "UserCode18": 1,
    "UserCode19": 1,
    "UserCode2": 1,
    "UserCode20": 1,
    "UserCode3": 1,
    "UserCode4": 1,
    "UserCode5": 1,
    "UserCode6": 1,
    "UserCode7": 1,
    "UserCode8": 1,
    "UserCode9": 1,
    "UserDate1": "2026-01-01",
    "UserDate10": "2026-01-01",
    "UserDate11": "2026-01-01",
    "UserDate12": "2026-01-01",
    "UserDate13": "2026-01-01",
    "UserDate14": "2026-01-01",
    "UserDate15": "2026-01-01",
    "UserDate16": "2026-01-01",
    "UserDate17": "2026-01-01",
    "UserDate18": "2026-01-01",
    "UserDate19": "2026-01-01",
    "UserDate2": "2026-01-01",
    "UserDate20": "2026-01-01",
    "UserDate3": "2026-01-01",
    "UserDate4": "2026-01-01",
    "UserDate5": "2026-01-01",
    "UserDate6": "2026-01-01",
    "UserDate7": "2026-01-01",
    "UserDate8": "2026-01-01",
    "UserDate9": "2026-01-01",
    "UserId": 1,
    "UserNumber1": 1,
    "UserNumber10": 1,
    "UserNumber11": 1,
    "UserNumber12": 1,
    "UserNumber13": 1,
    "UserNumber14": 1,
    "UserNumber15": 1,
    "UserNumber16": 1,
    "UserNumber17": 1,
    "UserNumber18": 1,
    "UserNumber19": 1,
    "UserNumber2": 1,
    "UserNumber20": 1,
    "UserNumber3": 1,
    "UserNumber4": 1,
    "UserNumber5": 1,
    "UserNumber6": 1,
    "UserNumber7": 1,
    "UserNumber8": 1,
    "UserNumber9": 1,
    "UserRate1": 1,
    "UserRate10": 1,
    "UserRate11": 1,
    "UserRate12": 1,
    "UserRate13": 1,
    "UserRate14": 1,
    "UserRate15": 1,
    "UserRate16": 1,
    "UserRate17": 1,
    "UserRate18": 1,
    "UserRate19": 1,
    "UserRate2": 1,
    "UserRate20": 1,
    "UserRate3": 1,
    "UserRate4": 1,
    "UserRate5": 1,
    "UserRate6": 1,
    "UserRate7": 1,
    "UserRate8": 1,
    "UserRate9": 1
  },
  "nxAttributes": {
    "customFields": {}
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": {
      "Record": "text",
      "ErrorCode": "text",
      "ErrorMessage": "text",
      "PrimaryKeyField": [
        {
          "Name": "text",
          "Value": "text"
        }
      ]
    }
  }
}
PrevioussearchShare
NextSite

Last updated

Was this helpful?