POST v1/core/channels/{chnId}/accounts

Creates a new account in the specified channel

Request Information

Parameters

Name	Description	Additional information
chnId	the channel id	Define this parameter in the request URI.
item	the new account object	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "AdminEmail": "sample string 1",
  "AdminPassword": "sample string 2",
  "CSI0": "sample string 3",
  "CSI1": "sample string 4",
  "CSI2": "sample string 5",
  "CSI3": "sample string 6",
  "ProductID": 7,
  "Currency": "sample string 8",
  "SendWelcomeEmail": true,
  "AutoProvision": true,
  "CycleStartDay": 11,
  "Details": {
    "ID": 1,
    "ChannelID": 2,
    "CANID": 3,
    "CANName": "sample string 4",
    "ChannelCode": "sample string 5",
    "AccountNumber": "sample string 6",
    "Organization": "sample string 7",
    "FirstName": "sample string 8",
    "LastName": "sample string 9",
    "ContactName": "sample string 10",
    "ContactEmail": "sample string 11",
    "ContactEmailLanguage": "sample string 12",
    "Address": "sample string 13",
    "Country": "sample string 14",
    "Telephone": "sample string 15",
    "Mobile": "sample string 16",
    "ForeignKey": "sample string 17",
    "ForeignKeyName": "sample string 18",
    "CSI0": "sample string 19",
    "CSI1": "sample string 20",
    "CSI2": "sample string 21",
    "CSI3": "sample string 22",
    "StartDate": "2025-05-23T21:05:46.7477943+00:00",
    "Status": "Enabled|Disabled",
    "TotalUsers": 24,
    "UsedUsers": 25,
    "TotalAgents": 26,
    "UsedAgents": 27,
    "HomeBroker": "sample string 28",
    "AdditionalBrokers": [
      "sample string 1",
      "sample string 2",
      "sample string 3"
    ],
    "UseSlothCategory": true
  },
  "OperatorName": "sample string 12",
  "OperatorCountry": "sample string 13",
  "IpRange": "sample string 14",
  "UseSlothCategory": true
}

text/javascript

Sample:

{"AdminEmail":"sample string 1","AdminPassword":"sample string 2","CSI0":"sample string 3","CSI1":"sample string 4","CSI2":"sample string 5","CSI3":"sample string 6","ProductID":7,"Currency":"sample string 8","SendWelcomeEmail":true,"AutoProvision":true,"CycleStartDay":11,"Details":{"ID":1,"ChannelID":2,"CANID":3,"CANName":"sample string 4","ChannelCode":"sample string 5","AccountNumber":"sample string 6","Organization":"sample string 7","FirstName":"sample string 8","LastName":"sample string 9","ContactName":"sample string 10","ContactEmail":"sample string 11","ContactEmailLanguage":"sample string 12","Address":"sample string 13","Country":"sample string 14","Telephone":"sample string 15","Mobile":"sample string 16","ForeignKey":"sample string 17","ForeignKeyName":"sample string 18","CSI0":"sample string 19","CSI1":"sample string 20","CSI2":"sample string 21","CSI3":"sample string 22","StartDate":"2025-05-23T21:05:46.7477943+00:00","Status":0,"TotalUsers":24,"UsedUsers":25,"TotalAgents":26,"UsedAgents":27,"HomeBroker":"sample string 28","AdditionalBrokers":["sample string 1","sample string 2","sample string 3"],"UseSlothCategory":true},"OperatorName":"sample string 12","OperatorCountry":"sample string 13","IpRange":"sample string 14","UseSlothCategory":true}

application/xml, text/xml

Sample:

<AccountSetup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models">
  <AdminEmail>sample string 1</AdminEmail>
  <AdminPassword>sample string 2</AdminPassword>
  <AutoProvision>true</AutoProvision>
  <CSI0>sample string 3</CSI0>
  <CSI1>sample string 4</CSI1>
  <CSI2>sample string 5</CSI2>
  <CSI3>sample string 6</CSI3>
  <Currency>sample string 8</Currency>
  <CycleStartDay>11</CycleStartDay>
  <Details>
    <AccountNumber>sample string 6</AccountNumber>
    <AdditionalBrokers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
      <d3p1:string>sample string 3</d3p1:string>
    </AdditionalBrokers>
    <Address>sample string 13</Address>
    <CANID>3</CANID>
    <CANName>sample string 4</CANName>
    <CSI0>sample string 19</CSI0>
    <CSI1>sample string 20</CSI1>
    <CSI2>sample string 21</CSI2>
    <CSI3>sample string 22</CSI3>
    <ChannelCode>sample string 5</ChannelCode>
    <ChannelID>2</ChannelID>
    <ContactEmail>sample string 11</ContactEmail>
    <ContactEmailLanguage>sample string 12</ContactEmailLanguage>
    <ContactName>sample string 10</ContactName>
    <Country>sample string 14</Country>
    <FirstName>sample string 8</FirstName>
    <ForeignKey>sample string 17</ForeignKey>
    <ForeignKeyName>sample string 18</ForeignKeyName>
    <HomeBroker>sample string 28</HomeBroker>
    <ID>1</ID>
    <LastName>sample string 9</LastName>
    <Mobile>sample string 16</Mobile>
    <Organization>sample string 7</Organization>
    <StartDate>2025-05-23T21:05:46.7477943+00:00</StartDate>
    <Status>Enabled|Disabled</Status>
    <Telephone>sample string 15</Telephone>
    <TotalAgents>26</TotalAgents>
    <TotalUsers>24</TotalUsers>
    <UseSlothCategory>true</UseSlothCategory>
    <UsedAgents>27</UsedAgents>
    <UsedUsers>25</UsedUsers>
  </Details>
  <IpRange>sample string 14</IpRange>
  <OperatorCountry>sample string 13</OperatorCountry>
  <OperatorName>sample string 12</OperatorName>
  <ProductID>7</ProductID>
  <SendWelcomeEmail>true</SendWelcomeEmail>
  <UseSlothCategory>true</UseSlothCategory>
</AccountSetup>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AccountSetup'.

application/bson

Sample:

AdminEmailsample string 1AdminPasswordsample string 2CSI0sample string 3CSI1sample string 4CSI2sample string 5CSI3sample string 6ProductIDCurrencysample string 8SendWelcomeEmailAutoProvisionCycleStartDayDetailsrIDChannelIDCANIDCANNamesample string 4ChannelCodesample string 5AccountNumbersample string 6Organizationsample string 7FirstNamesample string 8LastNamesample string 9ContactNamesample string 10ContactEmailsample string 11ContactEmailLanguagesample string 12Addresssample string 13Countrysample string 14Telephonesample string 15Mobilesample string 16ForeignKeysample string 17ForeignKeyNamesample string 18CSI0sample string 19CSI1sample string 20CSI2sample string 21CSI3sample string 22	StartDate�^���StatusTotalUsersUsedUsersTotalAgentsUsedAgentsHomeBrokersample string 28AdditionalBrokersJ0sample string 11sample string 22sample string 3UseSlothCategoryOperatorNamesample string 12OperatorCountrysample string 13IpRangesample string 14UseSlothCategory

Response Information

The new account object

Response body formats

application/json, text/json

Sample:

{
  "Success": true,
  "Data": {
    "ID": 1,
    "ChannelID": 2,
    "CANID": 3,
    "CANName": "sample string 4",
    "ChannelCode": "sample string 5",
    "AccountNumber": "sample string 6",
    "Organization": "sample string 7",
    "FirstName": "sample string 8",
    "LastName": "sample string 9",
    "ContactName": "sample string 10",
    "ContactEmail": "sample string 11",
    "ContactEmailLanguage": "sample string 12",
    "Address": "sample string 13",
    "Country": "sample string 14",
    "Telephone": "sample string 15",
    "Mobile": "sample string 16",
    "ForeignKey": "sample string 17",
    "ForeignKeyName": "sample string 18",
    "CSI0": "sample string 19",
    "CSI1": "sample string 20",
    "CSI2": "sample string 21",
    "CSI3": "sample string 22",
    "StartDate": "2025-05-23T21:05:46.7477943+00:00",
    "Status": "Enabled|Disabled",
    "TotalUsers": 24,
    "UsedUsers": 25,
    "TotalAgents": 26,
    "UsedAgents": 27,
    "HomeBroker": "sample string 28",
    "AdditionalBrokers": [
      "sample string 1",
      "sample string 2",
      "sample string 3"
    ],
    "UseSlothCategory": true
  },
  "ErrorCode": 2,
  "ErrorDescription": "sample string 3",
  "Meta": "sample string 4"
}

text/javascript

Sample:

{"Success":true,"Data":{"ID":1,"ChannelID":2,"CANID":3,"CANName":"sample string 4","ChannelCode":"sample string 5","AccountNumber":"sample string 6","Organization":"sample string 7","FirstName":"sample string 8","LastName":"sample string 9","ContactName":"sample string 10","ContactEmail":"sample string 11","ContactEmailLanguage":"sample string 12","Address":"sample string 13","Country":"sample string 14","Telephone":"sample string 15","Mobile":"sample string 16","ForeignKey":"sample string 17","ForeignKeyName":"sample string 18","CSI0":"sample string 19","CSI1":"sample string 20","CSI2":"sample string 21","CSI3":"sample string 22","StartDate":"2025-05-23T21:05:46.7477943+00:00","Status":0,"TotalUsers":24,"UsedUsers":25,"TotalAgents":26,"UsedAgents":27,"HomeBroker":"sample string 28","AdditionalBrokers":["sample string 1","sample string 2","sample string 3"],"UseSlothCategory":true},"ErrorCode":2,"ErrorDescription":"sample string 3","Meta":"sample string 4"}

application/xml, text/xml

Sample:

<PBNBReturnOfAccountCA1DLPoZ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models">
  <Data>
    <AccountNumber>sample string 6</AccountNumber>
    <AdditionalBrokers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
      <d3p1:string>sample string 3</d3p1:string>
    </AdditionalBrokers>
    <Address>sample string 13</Address>
    <CANID>3</CANID>
    <CANName>sample string 4</CANName>
    <CSI0>sample string 19</CSI0>
    <CSI1>sample string 20</CSI1>
    <CSI2>sample string 21</CSI2>
    <CSI3>sample string 22</CSI3>
    <ChannelCode>sample string 5</ChannelCode>
    <ChannelID>2</ChannelID>
    <ContactEmail>sample string 11</ContactEmail>
    <ContactEmailLanguage>sample string 12</ContactEmailLanguage>
    <ContactName>sample string 10</ContactName>
    <Country>sample string 14</Country>
    <FirstName>sample string 8</FirstName>
    <ForeignKey>sample string 17</ForeignKey>
    <ForeignKeyName>sample string 18</ForeignKeyName>
    <HomeBroker>sample string 28</HomeBroker>
    <ID>1</ID>
    <LastName>sample string 9</LastName>
    <Mobile>sample string 16</Mobile>
    <Organization>sample string 7</Organization>
    <StartDate>2025-05-23T21:05:46.7477943+00:00</StartDate>
    <Status>Enabled|Disabled</Status>
    <Telephone>sample string 15</Telephone>
    <TotalAgents>26</TotalAgents>
    <TotalUsers>24</TotalUsers>
    <UseSlothCategory>true</UseSlothCategory>
    <UsedAgents>27</UsedAgents>
    <UsedUsers>25</UsedUsers>
  </Data>
  <ErrorCode>2</ErrorCode>
  <ErrorDescription>sample string 3</ErrorDescription>
  <Meta>sample string 4</Meta>
  <Success>true</Success>
</PBNBReturnOfAccountCA1DLPoZ>

application/bson

Sample:

�SuccessDatarIDChannelIDCANIDCANNamesample string 4ChannelCodesample string 5AccountNumbersample string 6Organizationsample string 7FirstNamesample string 8LastNamesample string 9ContactNamesample string 10ContactEmailsample string 11ContactEmailLanguagesample string 12Addresssample string 13Countrysample string 14Telephonesample string 15Mobilesample string 16ForeignKeysample string 17ForeignKeyNamesample string 18CSI0sample string 19CSI1sample string 20CSI2sample string 21CSI3sample string 22	StartDate�^���StatusTotalUsersUsedUsersTotalAgentsUsedAgentsHomeBrokersample string 28AdditionalBrokersJ0sample string 11sample string 22sample string 3UseSlothCategoryErrorCodeErrorDescriptionsample string 3Metasample string 4