POST api/Partner

Creates a new partner account in SiteWit and returns all necessary data for linking in the parent Partner's internal systems.

Note on Address Info: The address info for the account is for invoiceing purposes. This can be the address of the parent Partner if all invoicing is being handled through them.

Request Information

Authentication Method

Partner Authentication

URI Parameters

None.

Body Parameters

Partner (Create)

Name	Description	Type	Additional information
name	Name of partner	string	Required String length: inclusive between 2 and 250
remoteId	Parent partner's internal identifier for this sub-partner (Optional)	string	String length: inclusive between 0 and 50
address	Collection of properties defining the billing address of the partner	Address (Create)	Required
whiteLabelSettings	Collection of properties defining how the white label site should appear	White Label Settings (Create)	Required
settlementCurrency	Default currency for campaign spend settlement. This will be the default for new accounts under this partner.	Currency
feeCurrencySetting	Defines how the currency is chosen when determining the correct fee item for a subscription	FeeCurrencySetting

Request Formats

application/json, text/json

Sample:

{
  "name": "My Partner",
  "remoteId": "84957345703003845",
  "address": {
    "street1": "123 Baxter Ct.",
    "street2": "Apt. 100",
    "city": "Coolsville",
    "stateProv": "FL",
    "countryCode": "US",
    "postalCode": "55555-5555"
  },
  "whiteLabelSettings": {
    "headerBgColor": "cccccc",
    "headerTextColor": "000000",
    "headerLogoUrl": "https://www.partner.com/resources/sw-wl-logo.png",
    "topBarBgColor": null,
    "topBarTextColor": null,
    "supportPhone": "800-555-0001",
    "supportEmail": "support@partner.com",
    "supportUrl": "https://support.partner.com",
    "mobileAppSplashScreenColor": "ffffff",
    "mobileAppPrimaryColor": "cccccc",
    "mobileAppPrimaryTextColor": "000000",
    "mobileAppSecondaryColor": "222222",
    "mobileAppSecondaryTextColor": "000000",
    "mobileAppLogoUrl": "https://www.partner.com/resources/sw-wl-logo-mobile.png",
    "features": [
      "SEM",
      "Analytics"
    ],
    "uiSettings": null,
    "partnerActions": [
      {
        "destinationType": "Message",
        "actionType": "DisplayBudget",
        "data": "display/[CAMPAIGN_ID]/modify"
      },
      {
        "destinationType": "Message",
        "actionType": "DisplayPurchase",
        "data": "display/[CAMPAIGN_ID]/purchase"
      },
      {
        "destinationType": "Message",
        "actionType": "DisplayCancel",
        "data": "display/[CAMPAIGN_ID]/cancel"
      },
      {
        "destinationType": "Message",
        "actionType": "DisplayReinstate",
        "data": "display/[CAMPAIGN_ID]/reinstate"
      }
    ],
    "platformPlugins": [
      {
        "platform": "WordPress",
        "url": "https://partner.com/plugin/wordpress"
      }
    ]
  },
  "settlementCurrency": "Undefined",
  "feeCurrencySetting": "AlwaysUSD"
}

application/xml, text/xml

Sample:

<Partner xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.CreateModels">
  <address>
    <city>Coolsville</city>
    <countryCode>US</countryCode>
    <postalCode>55555-5555</postalCode>
    <stateProv>FL</stateProv>
    <street1>123 Baxter Ct.</street1>
    <street2>Apt. 100</street2>
  </address>
  <feeCurrencySetting>AlwaysUSD</feeCurrencySetting>
  <name>My Partner</name>
  <remoteId>84957345703003845</remoteId>
  <settlementCurrency>Undefined</settlementCurrency>
  <whiteLabelSettings>
    <features xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>SEM</d3p1:string>
      <d3p1:string>Analytics</d3p1:string>
    </features>
    <headerBgColor>cccccc</headerBgColor>
    <headerLogoUrl>https://www.partner.com/resources/sw-wl-logo.png</headerLogoUrl>
    <headerTextColor>000000</headerTextColor>
    <mobileAppLogoUrl>https://www.partner.com/resources/sw-wl-logo-mobile.png</mobileAppLogoUrl>
    <mobileAppPrimaryColor>cccccc</mobileAppPrimaryColor>
    <mobileAppPrimaryTextColor>000000</mobileAppPrimaryTextColor>
    <mobileAppSecondaryColor>222222</mobileAppSecondaryColor>
    <mobileAppSecondaryTextColor>000000</mobileAppSecondaryTextColor>
    <mobileAppSplashScreenColor>ffffff</mobileAppSplashScreenColor>
    <partnerActions>
      <PartnerAction>
        <actionType xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models">DisplayBudget</actionType>
        <data xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models">display/[CAMPAIGN_ID]/modify</data>
        <destinationType xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">Message</destinationType>
      </PartnerAction>
      <PartnerAction>
        <actionType xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models">DisplayPurchase</actionType>
        <data xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models">display/[CAMPAIGN_ID]/purchase</data>
        <destinationType xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">Message</destinationType>
      </PartnerAction>
      <PartnerAction>
        <actionType xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models">DisplayCancel</actionType>
        <data xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models">display/[CAMPAIGN_ID]/cancel</data>
        <destinationType xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">Message</destinationType>
      </PartnerAction>
      <PartnerAction>
        <actionType xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models">DisplayReinstate</actionType>
        <data xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models">display/[CAMPAIGN_ID]/reinstate</data>
        <destinationType xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">Message</destinationType>
      </PartnerAction>
    </partnerActions>
    <platformPlugins>
      <PartnerPlugin>
        <platform xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">WordPress</platform>
        <url xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">https://partner.com/plugin/wordpress</url>
      </PartnerPlugin>
    </platformPlugins>
    <supportEmail>support@partner.com</supportEmail>
    <supportPhone>800-555-0001</supportPhone>
    <supportUrl>https://support.partner.com</supportUrl>
    <topBarBgColor i:nil="true" />
    <topBarTextColor i:nil="true" />
    <uiSettings xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  </whiteLabelSettings>
</Partner>

Response Information

Successful Response:

Resource Description

Partner

Name	Description	Type
address	Address of partner	Address
whiteLabelSettings	Settings for white label site	White Label Settings
partnerId	Partner identifier. Used for subsequent requests made on the partner's behalf	string
remoteId	Parent partner's internal identifier for this sub-partner	string
partnerToken	Partner secret token. Used for subsequent requests made on the partner's behalf	string
name	Name of partner	string
status	Partner's status	string
settlementCurrency	The default currency new accounts will settle their Campaign spend in if none is defined at time of account creation.	string
feeCurrencySetting	Defines how the currency is chosen when determining the correct fee item for a subscription	string

Response Formats

application/json, text/json

Sample:

{
  "address": {
    "street1": "123 Baxter Ct.",
    "street2": "Apt. 100",
    "city": "Coolsville",
    "stateProv": "FL",
    "postalCode": "55555-5555",
    "countryCode": "US"
  },
  "whiteLabelSettings": {
    "headerBgColor": "cccccc",
    "headerTextColor": "000000",
    "headerLogoUrl": "https://www.partner.com/resources/sw-wl-logo.png",
    "topBarBgColor": null,
    "topBarTextColor": null,
    "supportPhone": "800-555-0001",
    "supportEmail": "support@partner.com",
    "supportUrl": "https://support.partner.com",
    "mobileAppSplashScreenColor": "ffffff",
    "mobileAppPrimaryColor": "cccccc",
    "mobileAppPrimaryTextColor": "000000",
    "mobileAppSecondaryColor": "222222",
    "mobileAppSecondaryTextColor": "000000",
    "mobileAppLogoUrl": "https://www.partner.com/resources/sw-wl-logo-mobile.png",
    "features": [
      "SEM",
      "Analytics"
    ],
    "uiSettings": null,
    "partnerActions": [
      {
        "actionType": "DisplayBudget",
        "data": "display/[CAMPAIGN_ID]/modify"
      },
      {
        "actionType": "DisplayPurchase",
        "data": "display/[CAMPAIGN_ID]/purchase"
      },
      {
        "actionType": "DisplayCancel",
        "data": "display/[CAMPAIGN_ID]/cancel"
      },
      {
        "actionType": "DisplayReinstate",
        "data": "display/[CAMPAIGN_ID]/reinstate"
      }
    ],
    "platformPlugins": [
      {
        "platform": "WordPress",
        "url": "https://partner.com/plugin/wordpress"
      }
    ]
  },
  "partnerId": "11111111-zzzz-yyyy-xxxx-1234567890ab",
  "remoteId": "84957345703003845",
  "partnerToken": "pppppppppppppppppppppppppppppp",
  "name": "My Partner",
  "status": "Active",
  "settlementCurrency": "Undefined",
  "feeCurrencySetting": "AlwaysUSD"
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'SiteWit.PartnerAPI.Models.ReturnModels.PartnerAction' with data contract name 'PartnerAction:http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.ReturnModels' is not expected. Consider using a DataContractResolver if you are using DataContractSerializer or add any types not known statically to the list of known types - for example, by using the KnownTypeAttribute attribute or by adding them to the list of known types passed to the serializer.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'SiteWit.PartnerAPI.Models.ReturnModels.PartnerAction' with data contract name 'PartnerAction:http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.ReturnModels' is not expected. Consider using a DataContractResolver if you are using DataContractSerializer or add any types not known statically to the list of known types - for example, by using the KnownTypeAttribute attribute or by adding them to the list of known types passed to the serializer.