POST api/CreateCompanyCredential

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
Name	string	None.
Type	string	None.
Code	string	None.
WebhookUrl	string	None.
RequestType	string	None.
RequestPayload	string	None.
IsActive	boolean	None.
Credential	NotificationCredentialVm	None.
RawCredential	Object	None.
UserCompanyCredentials	Collection of UserCompanyCredentialsVm	None.
CompanyCredentialVariables	Collection of CompanyCredentialVariableVm	None.
CompanyWebhooks	Collection of SaveCompanyWebhookVms	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Name": "sample string 2",
  "Type": "sample string 3",
  "Code": "sample string 4",
  "WebhookUrl": "sample string 5",
  "RequestType": "sample string 6",
  "RequestPayload": "sample string 7",
  "IsActive": true,
  "Credential": {
    "ApiKey": "sample string 1",
    "FromNumber": "sample string 2",
    "Sender": "sample string 3",
    "AppId": "sample string 4",
    "AccessToken": "sample string 5",
    "ApiEndpoint": "sample string 6",
    "ApiToken": "sample string 7",
    "ApiSubDomain": "sample string 8",
    "AccountSID": "sample string 9",
    "CallerId": "sample string 10",
    "HasUserWiseEmail": true,
    "FromEmail": "sample string 12",
    "FromEmailName": "sample string 13",
    "ReplyToEmail": "sample string 14",
    "HostUrl": "sample string 15",
    "HostPort": 16,
    "Password": "sample string 17",
    "VirtualNumber": "sample string 18",
    "id": "sample string 19",
    "name": "sample string 20",
    "email": "sample string 21",
    "authToken": "sample string 22",
    "CompanyId": "sample string 23",
    "IvrId": "sample string 24",
    "Api": "sample string 25",
    "source": "sample string 26",
    "user": "sample string 27",
    "pass": "sample string 28",
    "agent_user": "sample string 29",
    "function": "sample string 30",
    "value": "sample string 31",
    "phone_code": "sample string 32",
    "UserName": "sample string 33",
    "OnlineCampaignName": "sample string 34",
    "OfflineCampaignName": "sample string 35",
    "Did": "sample string 36"
  },
  "RawCredential": {},
  "UserCompanyCredentials": [
    {
      "Id": 1,
      "UserId": 1,
      "CompanyCredentialId": 1,
      "Type": "sample string 2",
      "TypeId": "sample string 3",
      "SubType": "sample string 4",
      "SubTypeId": "sample string 5",
      "IsActive": true
    },
    {
      "Id": 1,
      "UserId": 1,
      "CompanyCredentialId": 1,
      "Type": "sample string 2",
      "TypeId": "sample string 3",
      "SubType": "sample string 4",
      "SubTypeId": "sample string 5",
      "IsActive": true
    }
  ],
  "CompanyCredentialVariables": [
    {
      "Id": 1,
      "VariableType": "sample string 2",
      "VariableName": "sample string 3",
      "VariableValue": "sample string 4",
      "VariableDesc": "sample string 5",
      "IsStatic": true
    },
    {
      "Id": 1,
      "VariableType": "sample string 2",
      "VariableName": "sample string 3",
      "VariableValue": "sample string 4",
      "VariableDesc": "sample string 5",
      "IsStatic": true
    }
  ],
  "CompanyWebhooks": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "MasterWebhookId": 3,
      "UniqueId": "sample string 4",
      "WebhookUrl": "sample string 5",
      "IsActive": true,
      "WebhookFieldMappings": [
        {
          "Id": 1,
          "SourceField": "sample string 2",
          "FieldCode": "sample string 3",
          "WebhookTargetFieldId": 1
        },
        {
          "Id": 1,
          "SourceField": "sample string 2",
          "FieldCode": "sample string 3",
          "WebhookTargetFieldId": 1
        }
      ],
      "CompanyWebhookConditions": [
        {
          "Id": 1,
          "TypeId": 2,
          "SubTypeId": 3,
          "Type": "sample string 4",
          "SubType": "sample string 5",
          "CompanyWebhookId": 6
        },
        {
          "Id": 1,
          "TypeId": 2,
          "SubTypeId": 3,
          "Type": "sample string 4",
          "SubType": "sample string 5",
          "CompanyWebhookId": 6
        }
      ]
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "MasterWebhookId": 3,
      "UniqueId": "sample string 4",
      "WebhookUrl": "sample string 5",
      "IsActive": true,
      "WebhookFieldMappings": [
        {
          "Id": 1,
          "SourceField": "sample string 2",
          "FieldCode": "sample string 3",
          "WebhookTargetFieldId": 1
        },
        {
          "Id": 1,
          "SourceField": "sample string 2",
          "FieldCode": "sample string 3",
          "WebhookTargetFieldId": 1
        }
      ],
      "CompanyWebhookConditions": [
        {
          "Id": 1,
          "TypeId": 2,
          "SubTypeId": 3,
          "Type": "sample string 4",
          "SubType": "sample string 5",
          "CompanyWebhookId": 6
        },
        {
          "Id": 1,
          "TypeId": 2,
          "SubTypeId": 3,
          "Type": "sample string 4",
          "SubType": "sample string 5",
          "CompanyWebhookId": 6
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<SaveCompanyCredentialVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Models.SuperAdminModels">
  <Code>sample string 4</Code>
  <CompanyCredentialVariables>
    <CompanyCredentialVariableVm>
      <Id>1</Id>
      <IsStatic>true</IsStatic>
      <VariableDesc>sample string 5</VariableDesc>
      <VariableName>sample string 3</VariableName>
      <VariableType>sample string 2</VariableType>
      <VariableValue>sample string 4</VariableValue>
    </CompanyCredentialVariableVm>
    <CompanyCredentialVariableVm>
      <Id>1</Id>
      <IsStatic>true</IsStatic>
      <VariableDesc>sample string 5</VariableDesc>
      <VariableName>sample string 3</VariableName>
      <VariableType>sample string 2</VariableType>
      <VariableValue>sample string 4</VariableValue>
    </CompanyCredentialVariableVm>
  </CompanyCredentialVariables>
  <CompanyWebhooks>
    <SaveCompanyWebhookVms>
      <CompanyWebhookConditions>
        <CompanyWebhookConditionVms>
          <CompanyWebhookId>6</CompanyWebhookId>
          <Id>1</Id>
          <SubType>sample string 5</SubType>
          <SubTypeId>3</SubTypeId>
          <Type>sample string 4</Type>
          <TypeId>2</TypeId>
        </CompanyWebhookConditionVms>
        <CompanyWebhookConditionVms>
          <CompanyWebhookId>6</CompanyWebhookId>
          <Id>1</Id>
          <SubType>sample string 5</SubType>
          <SubTypeId>3</SubTypeId>
          <Type>sample string 4</Type>
          <TypeId>2</TypeId>
        </CompanyWebhookConditionVms>
      </CompanyWebhookConditions>
      <Id>1</Id>
      <IsActive>true</IsActive>
      <MasterWebhookId>3</MasterWebhookId>
      <Name>sample string 2</Name>
      <UniqueId>sample string 4</UniqueId>
      <WebhookFieldMappings xmlns:d4p1="http://schemas.datacontract.org/2004/07/BrokerServer.Models.WebhookModels">
        <d4p1:SaveWebhookFieldMappingVm>
          <d4p1:FieldCode>sample string 3</d4p1:FieldCode>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:SourceField>sample string 2</d4p1:SourceField>
          <d4p1:WebhookTargetFieldId>1</d4p1:WebhookTargetFieldId>
        </d4p1:SaveWebhookFieldMappingVm>
        <d4p1:SaveWebhookFieldMappingVm>
          <d4p1:FieldCode>sample string 3</d4p1:FieldCode>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:SourceField>sample string 2</d4p1:SourceField>
          <d4p1:WebhookTargetFieldId>1</d4p1:WebhookTargetFieldId>
        </d4p1:SaveWebhookFieldMappingVm>
      </WebhookFieldMappings>
      <WebhookUrl>sample string 5</WebhookUrl>
    </SaveCompanyWebhookVms>
    <SaveCompanyWebhookVms>
      <CompanyWebhookConditions>
        <CompanyWebhookConditionVms>
          <CompanyWebhookId>6</CompanyWebhookId>
          <Id>1</Id>
          <SubType>sample string 5</SubType>
          <SubTypeId>3</SubTypeId>
          <Type>sample string 4</Type>
          <TypeId>2</TypeId>
        </CompanyWebhookConditionVms>
        <CompanyWebhookConditionVms>
          <CompanyWebhookId>6</CompanyWebhookId>
          <Id>1</Id>
          <SubType>sample string 5</SubType>
          <SubTypeId>3</SubTypeId>
          <Type>sample string 4</Type>
          <TypeId>2</TypeId>
        </CompanyWebhookConditionVms>
      </CompanyWebhookConditions>
      <Id>1</Id>
      <IsActive>true</IsActive>
      <MasterWebhookId>3</MasterWebhookId>
      <Name>sample string 2</Name>
      <UniqueId>sample string 4</UniqueId>
      <WebhookFieldMappings xmlns:d4p1="http://schemas.datacontract.org/2004/07/BrokerServer.Models.WebhookModels">
        <d4p1:SaveWebhookFieldMappingVm>
          <d4p1:FieldCode>sample string 3</d4p1:FieldCode>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:SourceField>sample string 2</d4p1:SourceField>
          <d4p1:WebhookTargetFieldId>1</d4p1:WebhookTargetFieldId>
        </d4p1:SaveWebhookFieldMappingVm>
        <d4p1:SaveWebhookFieldMappingVm>
          <d4p1:FieldCode>sample string 3</d4p1:FieldCode>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:SourceField>sample string 2</d4p1:SourceField>
          <d4p1:WebhookTargetFieldId>1</d4p1:WebhookTargetFieldId>
        </d4p1:SaveWebhookFieldMappingVm>
      </WebhookFieldMappings>
      <WebhookUrl>sample string 5</WebhookUrl>
    </SaveCompanyWebhookVms>
  </CompanyWebhooks>
  <Credential xmlns:d2p1="http://schemas.datacontract.org/2004/07/BrokerServer.Api">
    <d2p1:AccessToken>sample string 5</d2p1:AccessToken>
    <d2p1:AccountSID>sample string 9</d2p1:AccountSID>
    <d2p1:Api>sample string 25</d2p1:Api>
    <d2p1:ApiEndpoint>sample string 6</d2p1:ApiEndpoint>
    <d2p1:ApiKey>sample string 1</d2p1:ApiKey>
    <d2p1:ApiSubDomain>sample string 8</d2p1:ApiSubDomain>
    <d2p1:ApiToken>sample string 7</d2p1:ApiToken>
    <d2p1:AppId>sample string 4</d2p1:AppId>
    <d2p1:CallerId>sample string 10</d2p1:CallerId>
    <d2p1:CompanyId>sample string 23</d2p1:CompanyId>
    <d2p1:Did>sample string 36</d2p1:Did>
    <d2p1:FromEmail>sample string 12</d2p1:FromEmail>
    <d2p1:FromEmailName>sample string 13</d2p1:FromEmailName>
    <d2p1:FromNumber>sample string 2</d2p1:FromNumber>
    <d2p1:HasUserWiseEmail>true</d2p1:HasUserWiseEmail>
    <d2p1:HostPort>16</d2p1:HostPort>
    <d2p1:HostUrl>sample string 15</d2p1:HostUrl>
    <d2p1:IvrId>sample string 24</d2p1:IvrId>
    <d2p1:OfflineCampaignName>sample string 35</d2p1:OfflineCampaignName>
    <d2p1:OnlineCampaignName>sample string 34</d2p1:OnlineCampaignName>
    <d2p1:Password>sample string 17</d2p1:Password>
    <d2p1:ReplyToEmail>sample string 14</d2p1:ReplyToEmail>
    <d2p1:Sender>sample string 3</d2p1:Sender>
    <d2p1:UserName>sample string 33</d2p1:UserName>
    <d2p1:VirtualNumber>sample string 18</d2p1:VirtualNumber>
    <d2p1:agent_user>sample string 29</d2p1:agent_user>
    <d2p1:authToken>sample string 22</d2p1:authToken>
    <d2p1:email>sample string 21</d2p1:email>
    <d2p1:function>sample string 30</d2p1:function>
    <d2p1:id>sample string 19</d2p1:id>
    <d2p1:name>sample string 20</d2p1:name>
    <d2p1:pass>sample string 28</d2p1:pass>
    <d2p1:phone_code>sample string 32</d2p1:phone_code>
    <d2p1:source>sample string 26</d2p1:source>
    <d2p1:user>sample string 27</d2p1:user>
    <d2p1:value>sample string 31</d2p1:value>
  </Credential>
  <Id>1</Id>
  <IsActive>true</IsActive>
  <Name>sample string 2</Name>
  <RawCredential />
  <RequestPayload>sample string 7</RequestPayload>
  <RequestType>sample string 6</RequestType>
  <Type>sample string 3</Type>
  <UserCompanyCredentials>
    <UserCompanyCredentialsVm>
      <CompanyCredentialId>1</CompanyCredentialId>
      <Id>1</Id>
      <IsActive>true</IsActive>
      <SubType>sample string 4</SubType>
      <SubTypeId>sample string 5</SubTypeId>
      <Type>sample string 2</Type>
      <TypeId>sample string 3</TypeId>
      <UserId>1</UserId>
    </UserCompanyCredentialsVm>
    <UserCompanyCredentialsVm>
      <CompanyCredentialId>1</CompanyCredentialId>
      <Id>1</Id>
      <IsActive>true</IsActive>
      <SubType>sample string 4</SubType>
      <SubTypeId>sample string 5</SubTypeId>
      <Type>sample string 2</Type>
      <TypeId>sample string 3</TypeId>
      <UserId>1</UserId>
    </UserCompanyCredentialsVm>
  </UserCompanyCredentials>
  <WebhookUrl>sample string 5</WebhookUrl>
</SaveCompanyCredentialVm>

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 'SaveCompanyCredentialVm'.

Response Information

Resource Description

Response

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
Description	string	None.
Data	Object	None.
Count	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "Description": "sample string 3",
  "Data": {},
  "Count": 5
}

application/xml, text/xml

Sample:

<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Models">
  <Count>5</Count>
  <Data />
  <Description>sample string 3</Description>
  <Message>sample string 2</Message>
  <Success>true</Success>
</Response>