--- updatedAt: 2025-06-04T21:28:01.000Z agentTools: projectIndex: https://developer.simpplr.com/llms.txt --- # Create a Site Use this API to create a new Site. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "simpplr-api-gateway", "version": "1.0" }, "servers": [ { "url": "https://api.ec.simpplr.com/api" } ], "components": { "securitySchemes": { "sec0": { "type": "oauth2", "flows": {} } } }, "security": [ { "sec0": [] } ], "paths": { "/sites": { "post": { "summary": "Create a Site", "description": "Use this API to create a new Site.", "operationId": "create-a-site", "parameters": [ { "name": "x-user-email", "in": "header", "description": "User's email to login into Salesforce", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "access", "landing-page", "name", "is-content-submissions-enabled", "is-question-answer-enabled", "is-membership-auto-approved", "category-name" ], "properties": { "access": { "type": "string", "description": "Access level for this Site", "default": "public", "enum": [ "public", "private", "unlisted" ] }, "landing-page": { "type": "string", "description": "Which site page is used as the landing page? (Should be dashboard if the dashboard is enabled)", "default": "dashboard", "enum": [ "dashboard", "feed", "content", "files", "about" ] }, "is-owner": { "type": "boolean", "description": "Is the current user the Owner of this Site?", "default": false }, "has-pages": { "type": "boolean", "description": "Is the Pages feature enabled for this Site?", "default": true }, "name": { "type": "string", "description": "Site name (max length : 255)", "default": "Site created from Developer Portal" }, "has-events": { "type": "boolean", "description": "Is the Events feature enabled for this Site?", "default": false }, "has-dashboard": { "type": "boolean", "description": "Is the dashboard feature enabled for this Site?", "default": true }, "has-albums": { "type": "boolean", "description": "Is the Albums feature enabled for this Site?", "default": true }, "is-content-submissions-enabled": { "type": "boolean", "description": "Is content submission allowed for this Site?", "default": true }, "is-question-answer-enabled": { "type": "boolean", "description": "Can this Site have a Q&A section", "default": true }, "is-membership-auto-approved": { "type": "boolean", "default": true }, "category-name": { "type": "string", "description": "Name of Category in which user want to create site", "default": "Uncategorized" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": \"success\",\n \"result\": {\n \"url\": \"https://xxx.visualforce.com/apex/app?u=/site/a1A5e000001wXnxxx/dashboard\",\n \"title\": \"Test API Site arun postman\",\n \"teams\": false,\n \"storageProvider\": \"intranet\",\n \"siteId\": \"a1A5e000001wXnhxxx\",\n \"name\": \"Test API Site arun postman\",\n \"members\": 1,\n \"memberCount\": 1,\n \"managerCount\": 1,\n \"landingPage\": \"dashboard\",\n \"isQuestionAnswerEnabled\": true,\n \"isPrivate\": false,\n \"isOwner\": true,\n \"isMembershipAutoApproved\": false,\n \"isMember\": true,\n \"isManager\": true,\n \"isListed\": true,\n \"isInMandatorySubscription\": false,\n \"isFollower\": false,\n \"isFeatured\": false,\n \"isFavorited\": false,\n \"isContentSubmissionsEnabled\": true,\n \"isContentManager\": false,\n \"isContentFeedEnabled\": true,\n \"isBroadcast\": false,\n \"isActive\": true,\n \"isAccessRequested\": false,\n \"id\": \"a1A5e000001wXxxx\",\n \"hasPages\": true,\n \"hasEvents\": true,\n \"hasDashboard\": true,\n \"hasContent\": false,\n \"hasAlbums\": true,\n \"followerCount\": 0,\n \"editUrl\": \"https://xxxx.visualforce.com/apex/app?u=/manage/sites/a1A5e000001wXnhxxx\",\n \"dashboardLayout\": \"e\",\n \"createdAt\": \"2021-09-14T21:43:48.000+0530\",\n \"chatterGroupId\": \"0F95e00000068tGxxx\",\n \"category\": {\n \"url\": \"https://xxxx.visualforce.com/apex/app?u=/sites/category?category=a1C5e0000006pbxxx\",\n \"name\": \"Uncategorized\",\n \"id\": \"a1C5e0000006pbbExxx\"\n },\n \"canMention\": true,\n \"canEdit\": true,\n \"canCreatePage\": true,\n \"canCreateEvent\": true,\n \"canCreateAlbum\": true,\n \"canActivateDeactivate\": true,\n \"analytics\": {\n \"totalPageCount\": 0,\n \"totalEventCount\": 0,\n \"totalAlbumCount\": 0,\n \"csvUrl\": \"https://xxx.visualforce.com/apex/Reports?action=geSiteContentTypes&SiteId=a1A5e000001wXnxxx\"\n },\n \"access\": \"Public\"\n },\n \"responseTimeStamp\": \"1631636030166\",\n \"redirectUrl\": \"https://xxx.visualforce.com/apex/app?u=/site/a1A5e000001wXnxxx/dashboard\",\n \"message\": \"\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "result": { "type": "object", "properties": { "url": { "type": "string", "example": "https://xxx.visualforce.com/apex/app?u=/site/a1A5e000001wXnxxx/dashboard" }, "title": { "type": "string", "example": "Test API Site arun postman" }, "teams": { "type": "boolean", "example": false, "default": true }, "storageProvider": { "type": "string", "example": "intranet" }, "siteId": { "type": "string", "example": "a1A5e000001wXnhxxx" }, "name": { "type": "string", "example": "Test API Site arun postman" }, "members": { "type": "integer", "example": 1, "default": 0 }, "memberCount": { "type": "integer", "example": 1, "default": 0 }, "managerCount": { "type": "integer", "example": 1, "default": 0 }, "landingPage": { "type": "string", "example": "dashboard" }, "isQuestionAnswerEnabled": { "type": "boolean", "example": true, "default": true }, "isPrivate": { "type": "boolean", "example": false, "default": true }, "isOwner": { "type": "boolean", "example": true, "default": true }, "isMembershipAutoApproved": { "type": "boolean", "example": false, "default": true }, "isMember": { "type": "boolean", "example": true, "default": true }, "isManager": { "type": "boolean", "example": true, "default": true }, "isListed": { "type": "boolean", "example": true, "default": true }, "isInMandatorySubscription": { "type": "boolean", "example": false, "default": true }, "isFollower": { "type": "boolean", "example": false, "default": true }, "isFeatured": { "type": "boolean", "example": false, "default": true }, "isFavorited": { "type": "boolean", "example": false, "default": true }, "isContentSubmissionsEnabled": { "type": "boolean", "example": true, "default": true }, "isContentManager": { "type": "boolean", "example": false, "default": true }, "isContentFeedEnabled": { "type": "boolean", "example": true, "default": true }, "isBroadcast": { "type": "boolean", "example": false, "default": true }, "isActive": { "type": "boolean", "example": true, "default": true }, "isAccessRequested": { "type": "boolean", "example": false, "default": true }, "id": { "type": "string", "example": "a1A5e000001wXxxx" }, "hasPages": { "type": "boolean", "example": true, "default": true }, "hasEvents": { "type": "boolean", "example": true, "default": true }, "hasDashboard": { "type": "boolean", "example": true, "default": true }, "hasContent": { "type": "boolean", "example": false, "default": true }, "hasAlbums": { "type": "boolean", "example": true, "default": true }, "followerCount": { "type": "integer", "example": 0, "default": 0 }, "editUrl": { "type": "string", "example": "https://xxxx.visualforce.com/apex/app?u=/manage/sites/a1A5e000001wXnhxxx" }, "dashboardLayout": { "type": "string", "example": "e" }, "createdAt": { "type": "string", "example": "2021-09-14T21:43:48.000+0530" }, "chatterGroupId": { "type": "string", "example": "0F95e00000068tGxxx" }, "category": { "type": "object", "properties": { "url": { "type": "string", "example": "https://xxxx.visualforce.com/apex/app?u=/sites/category?category=a1C5e0000006pbxxx" }, "name": { "type": "string", "example": "Uncategorized" }, "id": { "type": "string", "example": "a1C5e0000006pbbExxx" } } }, "canMention": { "type": "boolean", "example": true, "default": true }, "canEdit": { "type": "boolean", "example": true, "default": true }, "canCreatePage": { "type": "boolean", "example": true, "default": true }, "canCreateEvent": { "type": "boolean", "example": true, "default": true }, "canCreateAlbum": { "type": "boolean", "example": true, "default": true }, "canActivateDeactivate": { "type": "boolean", "example": true, "default": true }, "analytics": { "type": "object", "properties": { "totalPageCount": { "type": "integer", "example": 0, "default": 0 }, "totalEventCount": { "type": "integer", "example": 0, "default": 0 }, "totalAlbumCount": { "type": "integer", "example": 0, "default": 0 }, "csvUrl": { "type": "string", "example": "https://xxx.visualforce.com/apex/Reports?action=geSiteContentTypes&SiteId=a1A5e000001wXnxxx" } } }, "access": { "type": "string", "example": "Public" } } }, "responseTimeStamp": { "type": "string", "example": "1631636030166" }, "redirectUrl": { "type": "string", "example": "https://xxx.visualforce.com/apex/app?u=/site/a1A5e000001wXnxxx/dashboard" }, "message": { "type": "string", "example": "" } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": \"error\",\n \"message\": \"SESSION_TIMEOUT\",\n \"i18nmessage\": \"SESSION_TIMEOUT\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "SESSION_TIMEOUT" }, "i18nmessage": { "type": "string", "example": "SESSION_TIMEOUT" } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```