POST v2/apps/{appId}/tenants
Create a Tenant inside the master app, NOTE Leave the footer empty to replicate master footer.
Request Information
URI Parameters
Name | Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
appId | integer |
Additional Info :
Required |
Body Parameters
TenantCreateRequestName | Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
AppId | integer |
Application Id this tenant belongs to
Additional Info :
Required |
|||||||||||
DisplayName | string |
Name displayed in Application
Additional Info :
Required |
|||||||||||
IconUrl | string |
Url to the Icon/Avatar to display in the Application |
|||||||||||
SplashUrl | string |
Url to the Splash Image for the Tenant, displayed when it is the chosen tenant |
|||||||||||
Url | string |
Url of the Site for the Tenant to load on start up. Must be a full absolute url including the http or https scheme
Additional Info :
Required |
|||||||||||
Disabled | boolean |
True if the Tenant is disabled, the application will behave as if it is deleted |
|||||||||||
Hidden | boolean |
If true, the tenant will not be displayed in the application, but can still be used or switched to using a deep link |
|||||||||||
DisplayOrder | integer |
Relative number to specify the order the Tenant is displayed in the listing |
|||||||||||
Description | string |
Description of the tenant app |
|||||||||||
FirstName | string |
First name of the owner or person responsible for the tenant app
Additional Info :
Required Length between 0 and 50 |
|||||||||||
LastName | string |
Last Name of the owner or person responsible for the tenant app
Additional Info :
Required Length between 0 and 50 |
|||||||||||
Phone | string |
Phone number of the owner or person responsible for the tenant app
Additional Info :
Length between 0 and 50 |
|||||||||||
SupportEmail | string |
Email address of the owner or person responsible for the tenant app
Additional Info :
Length between 0 and 180 Matching: (?i)^[a-z0-9._%+-]+@(?:[a-z0-9][a-z0-9-]*\.)+[a-z]{2,}$ |
|||||||||||
SupportSite | string |
Optional support url for the tenant app, may be different than the Url |
|||||||||||
Footer | FooterRequest |
Optional footer information to use for this tenant |
|||||||||||
Tag | string |
Optional associated data for the tenant, for instance a database id of the member its for |
|||||||||||
SocialDescription | string |
Social Description used when posting links to social media Maximum string length of 255 any extra will be trimmed. |
|||||||||||
RollOverId | integer |
If the tenant gets deleted it will redirect the user to that rollover id |
|||||||||||
LandingPage | HomeRequest |
Optional landing page feature data for ionic apps. |
|||||||||||
FacebookUrl | string |
Facebook Page Url |
|||||||||||
TwitterUrl | string |
Twitter Page Url |
|||||||||||
LinkedInUrl | string |
LinkedInUrl Url |
|||||||||||
GooglePlusUrl | string |
GooglePlus Page Url |
|||||||||||
IonicTemplateId | string |
If the ionic template supports multiple design for the tenant. (Id is based on the template). |
|||||||||||
Source | string |
The location of the tenant when it was created. |
|||||||||||
Category | string |
Category of the tenant : Auto & Vehicles, Beauty, Book & Reference, Business, Catalogs, Comics, Communications, Dating, Education, Events, Entertainment, Finance, Food & Drink, Games, Health & Fitness, House & Home, House & Home, Kids, Libraries & Demo, Lifestyle, Magazines & Newspapers, Maps & Navigation, Medical, Music & Audio, Navigation, News & Magazines, Parenting, Personalization, Photography, Productivity, Reference, Shopping, Social, Sports, Tools, Travel & Local, Utilities |
Request Formats
{ "appId": 1234, "displayName": "Bob's Plumbing", "iconUrl": "http://imagehosting.com/AGOEN32SDSAE392DSAJ", "splashUrl": "http://imagehosting.com/AOEUHGDEG832KGd", "url": "http://bobdoesplumbing.com/", "disabled": false, "hidden": false, "displayOrder": 4, "description": null, "firstName": null, "lastName": null, "phone": null, "supportEmail": null, "supportSite": null, "footer": { "footerType": 1, "footerData": [ { "title": "Home", "url": "http://myhomepage.com", "image": "glyphicon glyphicon-home", "imageCode": null, "fColor": "000000", "bColor": "ffffff", "sTabColor": "ffffff", "isBurger": false, "type": null }, { "title": "Phone", "url": "tel:314-433-3222", "image": "fa fa-phone-square", "imageCode": null, "fColor": "000000", "bColor": "ffffff", "sTabColor": "ffffff", "isBurger": false, "type": null }, { "title": "Push Log", "url": "native:pushlog", "image": "fa fa-comments-o", "imageCode": null, "fColor": "000000", "bColor": "ffffff", "sTabColor": "ffffff", "isBurger": false, "type": null }, { "title": "Email", "url": "mailto:support@appnotch.com", "image": "glyphicon glyphicon-envelope", "imageCode": null, "fColor": "000000", "bColor": "ffffff", "sTabColor": "ffffff", "isBurger": false, "type": null }, { "title": "Social", "url": "http://facebook.com/appnotch", "image": "glyphicon glyphicon-globe", "imageCode": null, "fColor": "000000", "bColor": "ffffff", "sTabColor": "ffffff", "isBurger": false, "type": null } ] }, "tag": "My Custom Tag", "socialDescription": null, "rollOverId": 0, "landingPage": null, "facebookUrl": null, "twitterUrl": null, "linkedInUrl": null, "googlePlusUrl": null, "ionicTemplateId": null, "source": "Dashboard", "category": null }
<TenantCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AppNotch.Converter.Api.Server.Models"> <AppId>1234</AppId> <Category i:nil="true" /> <Description i:nil="true" /> <Disabled>false</Disabled> <DisplayName>Bob's Plumbing</DisplayName> <DisplayOrder>4</DisplayOrder> <FacebookUrl i:nil="true" /> <FirstName i:nil="true" /> <Footer> <FooterData> <FooterItem> <BColor>ffffff</BColor> <FColor>000000</FColor> <Image>glyphicon glyphicon-home</Image> <ImageCode i:nil="true" /> <IsBurger>false</IsBurger> <STabColor>ffffff</STabColor> <Title>Home</Title> <Type i:nil="true" /> <Url>http://myhomepage.com</Url> </FooterItem> <FooterItem> <BColor>ffffff</BColor> <FColor>000000</FColor> <Image>fa fa-phone-square</Image> <ImageCode i:nil="true" /> <IsBurger>false</IsBurger> <STabColor>ffffff</STabColor> <Title>Phone</Title> <Type i:nil="true" /> <Url>tel:314-433-3222</Url> </FooterItem> <FooterItem> <BColor>ffffff</BColor> <FColor>000000</FColor> <Image>fa fa-comments-o</Image> <ImageCode i:nil="true" /> <IsBurger>false</IsBurger> <STabColor>ffffff</STabColor> <Title>Push Log</Title> <Type i:nil="true" /> <Url>native:pushlog</Url> </FooterItem> <FooterItem> <BColor>ffffff</BColor> <FColor>000000</FColor> <Image>glyphicon glyphicon-envelope</Image> <ImageCode i:nil="true" /> <IsBurger>false</IsBurger> <STabColor>ffffff</STabColor> <Title>Email</Title> <Type i:nil="true" /> <Url>mailto:support@appnotch.com</Url> </FooterItem> <FooterItem> <BColor>ffffff</BColor> <FColor>000000</FColor> <Image>glyphicon glyphicon-globe</Image> <ImageCode i:nil="true" /> <IsBurger>false</IsBurger> <STabColor>ffffff</STabColor> <Title>Social</Title> <Type i:nil="true" /> <Url>http://facebook.com/appnotch</Url> </FooterItem> </FooterData> <FooterType>1</FooterType> </Footer> <GooglePlusUrl i:nil="true" /> <Hidden>false</Hidden> <IconUrl>http://imagehosting.com/AGOEN32SDSAE392DSAJ</IconUrl> <IonicTemplateId i:nil="true" /> <LandingPage i:nil="true" /> <LastName i:nil="true" /> <LinkedInUrl i:nil="true" /> <Phone i:nil="true" /> <RollOverId>0</RollOverId> <SocialDescription i:nil="true" /> <Source>Dashboard</Source> <SplashUrl>http://imagehosting.com/AOEUHGDEG832KGd</SplashUrl> <SupportEmail i:nil="true" /> <SupportSite i:nil="true" /> <Tag>My Custom Tag</Tag> <TwitterUrl i:nil="true" /> <Url>http://bobdoesplumbing.com/</Url> </TenantCreateRequest>
Response Information
Resource Description
TenantFullResponseName | Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
FirstName | string |
First name of the owner or person responsible for the tenant app |
|||||||||||
LastName | string |
Last Name of the owner or person responsible for the tenant app |
|||||||||||
Phone | string |
Phone number of the owner or person responsible for the tenant app |
|||||||||||
SupportEmail | string |
Email address of the owner or person responsible for the tenant app |
|||||||||||
SupportSite | string |
Optional support url for the tenant app, may be different than the Url |
|||||||||||
Footer | FooterResponse |
Footer to be displayed if chosen (separate from master app) |
|||||||||||
Home | HomeResponse |
Home to be displayed if chosen |
|||||||||||
Tag | string |
Associated data for the tenant, for instance a database id of the member its for |
|||||||||||
SocialDescription | string |
Social Description used when posting links to social media Maximum string length of 255 any extra will be trimmed. |
|||||||||||
Id | integer |
Id of the Tenant |
|||||||||||
AppId | integer |
Application Id this tenant belongs to |
|||||||||||
DisplayName | string |
Name displayed in Application |
|||||||||||
IconUrl | string |
Url to the Icon/Avatar to display in the Application |
|||||||||||
IconUrl32x32 | string |
Url to the Icon/Avatar to display in the Application |
|||||||||||
SplashUrl | string |
Url to the Splash Image for the Tenant, displayed when it is the chosen tenant |
|||||||||||
Url | string |
Url of the Site for the Tenant to load on start up |
|||||||||||
Disabled | boolean |
True if the Tenant is disabled, won't be sent to the Application. Users with this Tenant Selected will revert to Master App |
|||||||||||
Hidden | boolean |
Not Displayed in List, but Available for use |
|||||||||||
DisplayOrder | integer |
Relative number to specify the order the Tenant is displayed in the listing |
|||||||||||
CreateDate | date |
Date the Tenant was created |
|||||||||||
FooterUrl | string |
Url of the Footer for the tenant |
|||||||||||
ShareContent | string |
Content to be used when the 'Share' button is tapped within the app. If null or empty the share button will be hidden. Typically this is the BranchUrl |
|||||||||||
BranchUrl | string |
Url for the Branch Deep link to open the app to this tenant |
|||||||||||
Description | string |
Description of the tenant app |
|||||||||||
FacebookLink | string |
Social Media Link : Facebook |
|||||||||||
TwitterLink | string |
Social Media Link : Twitter |
|||||||||||
LinkedInLink | string |
Social Media Link : Linked In |
|||||||||||
GooglePlus | string |
Social Media Link : Google+ |
|||||||||||
IonicTemplateId | string |
If the ionic template supports multiple design for the tenant. (Id is based on the template). |
|||||||||||
Source | string |
The location of the tenant when it was created. |
|||||||||||
Category | string |
Category of the tenant : Auto & Vehicles, Beauty, Book & Reference, Business, Catalogs, Comics, Communications, Dating, Education, Events, Entertainment, Finance, Food & Drink, Games, Health & Fitness, House & Home, House & Home, Kids, Libraries & Demo, Lifestyle, Magazines & Newspapers, Maps & Navigation, Medical, Music & Audio, Navigation, News & Magazines, Parenting, Personalization, Photography, Productivity, Reference, Shopping, Social, Sports, Tools, Travel & Local, Utilities |
Response Formats
{ "firstName": null, "lastName": null, "phone": null, "supportEmail": null, "supportSite": null, "footer": null, "home": null, "tag": "My Custom Tag", "socialDescription": null, "id": 412, "appId": 1234, "displayName": "Bob's Plumbing", "iconUrl": "http://imagehosting.com/AGOEN32SDSAE392DSAJ", "iconUrl32x32": null, "splashUrl": "http://imagehosting.com/AOEUHGDEG832KGd", "url": "http://bobdoesplumbing.com", "disabled": false, "hidden": false, "displayOrder": 4, "createDate": "2024-12-01T14:47:58.4072612Z", "footerUrl": "http://app.appnotch.com/converter/footer/tenant/412", "shareContent": "https://a2bc.app.link/ag7GFe26dE", "branchUrl": "https://a2bc.app.link/ag7GFe26dE", "description": "Hi, My Name is Bob, I have a small plumbing company based in Chicago, We service the south Central area, but always would love to help if you do not reside there. We provide all sorts of services for Residential and Commercial Properties. Request an free estimate appointment using this app!", "facebookLink": null, "twitterLink": null, "linkedInLink": null, "googlePlus": null, "ionicTemplateId": null, "source": null, "category": null }
<TenantFullResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AppNotch.Converter.Api.Server.Models"> <AppId>1234</AppId> <BranchUrl>https://a2bc.app.link/ag7GFe26dE</BranchUrl> <Category i:nil="true" /> <CreateDate>2024-12-01T14:47:58.4072612+00:00</CreateDate> <Description>Hi, My Name is Bob, I have a small plumbing company based in Chicago, We service the south Central area, but always would love to help if you do not reside there. We provide all sorts of services for Residential and Commercial Properties. Request an free estimate appointment using this app!</Description> <Disabled>false</Disabled> <DisplayName>Bob's Plumbing</DisplayName> <DisplayOrder>4</DisplayOrder> <FacebookLink i:nil="true" /> <FooterUrl>http://app.appnotch.com/converter/footer/tenant/412</FooterUrl> <GooglePlus i:nil="true" /> <Hidden>false</Hidden> <IconUrl>http://imagehosting.com/AGOEN32SDSAE392DSAJ</IconUrl> <IconUrl32x32 i:nil="true" /> <Id>412</Id> <IonicTemplateId i:nil="true" /> <LinkedInLink i:nil="true" /> <Phone i:nil="true" /> <ShareContent>https://a2bc.app.link/ag7GFe26dE</ShareContent> <Source i:nil="true" /> <SplashUrl>http://imagehosting.com/AOEUHGDEG832KGd</SplashUrl> <SupportEmail i:nil="true" /> <SupportSite i:nil="true" /> <TwitterLink i:nil="true" /> <Url>http://bobdoesplumbing.com</Url> <FirstName i:nil="true" /> <Footer i:nil="true" /> <Home i:nil="true" /> <LastName i:nil="true" /> <Phone i:nil="true" /> <SocialDescription i:nil="true" /> <SupportEmail i:nil="true" /> <SupportSite i:nil="true" /> <Tag>My Custom Tag</Tag> </TenantFullResponse>