POST zapier/subscribe

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
hookUrl	string	None.
triggerType	string	None.
agents	Collection of integer	None.
api_key	string	None.

Request Formats

application/json, text/json

Sample:

{
  "hookUrl": "sample string 1",
  "triggerType": "sample string 2",
  "agents": [
    1,
    2
  ],
  "api_key": "sample string 3"
}

application/xml, text/xml

Sample:

<SubscribeInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.ImportExport.Zapier">
  <agents xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </agents>
  <api_key>sample string 3</api_key>
  <hookUrl>sample string 1</hookUrl>
  <triggerType>sample string 2</triggerType>
</SubscribeInput>

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

Response Information

Resource Description

SubscribeOutput

Name	Description	Type	Additional information
id		integer	None.
ReturnStatus		ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:

<SubscribeOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.ImportExport.Zapier">
  <ReturnStatus xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Core">
    <Results>1</Results>
    <ReturnCode>1</ReturnCode>
    <ReturnMessage>sample string 2</ReturnMessage>
  </ReturnStatus>
  <id>1</id>
</SubscribeOutput>