Download OpenAPI specification:
Creates a new page for the selected clientId. This page won't be published until a domain is purchased.
Page object
| clientId required | string [ 5 .. 50 ] characters Client ID |
| templateId required | string Template ID. This will be obtained from the templates endpoint |
| scriptUrl | string <uri> Custom script URL. The script will be loaded at the end of the page |
required | object Profile information |
required | Array of objects (LinkSectionSchema) non-empty Ordered list of sections |
object Footer information |
{- "clientId": "string",
- "templateId": "modern-01",
- "profile": {
- "name": "John Doe",
- "brandName": "JD Notary",
- "mobile": "5104567890",
- "bio": "I am a notary public with 10 years of experience",
- "address": "1234 Main St, San Francisco, CA 94105",
- "ctas": [
- {
- "type": "button",
- "title": "Book an Appointment",
- "icon": "calendar"
}
]
}, - "sections": [
- {
- "title": "Social",
- "text": "Follow us on social media",
- "links": [
]
}
], - "footer": {
- "text": "Powered by SpotLite sites"
}
}
{- "id": "67ee01ffd87a29376aeb52b1",
- "clientId": "string",
- "templateId": "modern-01",
- "profile": {
- "name": "John Doe",
- "brandName": "JD Notary",
- "mobile": "5104567890",
- "bio": "I am a notary public with 10 years of experience",
- "address": "1234 Main St, San Francisco, CA 94105",
- "ctas": [
- {
- "type": "button",
- "title": "Book an Appointment",
- "icon": "calendar"
}
]
}, - "sections": [
- {
- "title": "Social",
- "text": "Follow us on social media",
- "links": [
]
}
], - "footer": {
- "text": "Powered by SpotLite sites"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "Preview",
- "domain": "jd-notary.pro",
- "versionId": "67ee0172690c0349c6a638fc"
}List the pages that belong to a client
| clientId required | string Unique client idendificator. This client id is the owner of the pages. |
[- {
- "id": "67ee01ffd87a29376aeb52b1",
- "clientId": "string",
- "templateId": "modern-01",
- "profile": {
- "name": "John Doe",
- "brandName": "JD Notary",
- "mobile": "5104567890",
- "bio": "I am a notary public with 10 years of experience",
- "address": "1234 Main St, San Francisco, CA 94105",
- "ctas": [
- {
- "type": "button",
- "title": "Book an Appointment",
- "icon": "calendar"
}
]
}, - "sections": [
- {
- "title": "Social",
- "text": "Follow us on social media",
- "links": [
]
}
], - "footer": {
- "text": "Powered by SpotLite sites"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "Preview",
- "domain": "jd-notary.pro",
- "versionId": "67ee0172690c0349c6a638fc"
}
][- {
- "templateId": "modern-01",
- "name": "Modern professional",
- "mobileThumbnails": [
], - "desktopThumbnails": [
]
}
]| id required | string (pageId) Example: 67ee01ffd87a29376aeb52b1 Unique ID of the page |
{- "id": "67ee01ffd87a29376aeb52b1",
- "clientId": "string",
- "templateId": "modern-01",
- "profile": {
- "name": "John Doe",
- "brandName": "JD Notary",
- "mobile": "5104567890",
- "bio": "I am a notary public with 10 years of experience",
- "address": "1234 Main St, San Francisco, CA 94105",
- "ctas": [
- {
- "type": "button",
- "title": "Book an Appointment",
- "icon": "calendar"
}
]
}, - "sections": [
- {
- "title": "Social",
- "text": "Follow us on social media",
- "links": [
]
}
], - "footer": {
- "text": "Powered by SpotLite sites"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "Preview",
- "domain": "jd-notary.pro",
- "versionId": "67ee0172690c0349c6a638fc"
}Get the list of versions for a page
| id required | string (pageId) Example: 67ee01ffd87a29376aeb52b1 Page ID |
| status | string (SiteStatus) Enum: "Preview" "Published" Optional. Filter by status |
[- {
- "id": "67ee01ffd87a29376aeb52b1",
- "clientId": "string",
- "templateId": "modern-01",
- "profile": {
- "name": "John Doe",
- "brandName": "JD Notary",
- "mobile": "5104567890",
- "bio": "I am a notary public with 10 years of experience",
- "address": "1234 Main St, San Francisco, CA 94105",
- "ctas": [
- {
- "type": "button",
- "title": "Book an Appointment",
- "icon": "calendar"
}
]
}, - "sections": [
- {
- "title": "Social",
- "text": "Follow us on social media",
- "links": [
]
}
], - "footer": {
- "text": "Powered by SpotLite sites"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "Preview",
- "domain": "jd-notary.pro",
- "versionId": "67ee0172690c0349c6a638fc"
}
]Creates a new preview version of the page. This will not change the current published version.
| id required | string (pageId) Example: 67ee01ffd87a29376aeb52b1 Page ID |
Full page object (this endpoint won't merge data with the existing page)
| clientId required | string [ 5 .. 50 ] characters Client ID |
| templateId required | string Template ID. This will be obtained from the templates endpoint |
| scriptUrl | string <uri> Custom script URL. The script will be loaded at the end of the page |
required | object Profile information |
required | Array of objects (LinkSectionSchema) non-empty Ordered list of sections |
object Footer information |
{- "clientId": "string",
- "templateId": "modern-01",
- "profile": {
- "name": "John Doe",
- "brandName": "JD Notary",
- "mobile": "5104567890",
- "bio": "I am a notary public with 10 years of experience",
- "address": "1234 Main St, San Francisco, CA 94105",
- "ctas": [
- {
- "type": "button",
- "title": "Book an Appointment",
- "icon": "calendar"
}
]
}, - "sections": [
- {
- "title": "Social",
- "text": "Follow us on social media",
- "links": [
]
}
], - "footer": {
- "text": "Powered by SpotLite sites"
}
}{- "id": "67ee01ffd87a29376aeb52b1",
- "clientId": "string",
- "templateId": "modern-01",
- "profile": {
- "name": "John Doe",
- "brandName": "JD Notary",
- "mobile": "5104567890",
- "bio": "I am a notary public with 10 years of experience",
- "address": "1234 Main St, San Francisco, CA 94105",
- "ctas": [
- {
- "type": "button",
- "title": "Book an Appointment",
- "icon": "calendar"
}
]
}, - "sections": [
- {
- "title": "Social",
- "text": "Follow us on social media",
- "links": [
]
}
], - "footer": {
- "text": "Powered by SpotLite sites"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "Preview",
- "domain": "jd-notary.pro",
- "versionId": "67ee0172690c0349c6a638fc"
}Get a specific version of the page
| id required | string (pageId) Example: 67ee01ffd87a29376aeb52b1 Page ID |
| versionId required | string Version ID |
{- "id": "67ee01ffd87a29376aeb52b1",
- "clientId": "string",
- "templateId": "modern-01",
- "profile": {
- "name": "John Doe",
- "brandName": "JD Notary",
- "mobile": "5104567890",
- "bio": "I am a notary public with 10 years of experience",
- "address": "1234 Main St, San Francisco, CA 94105",
- "ctas": [
- {
- "type": "button",
- "title": "Book an Appointment",
- "icon": "calendar"
}
]
}, - "sections": [
- {
- "title": "Social",
- "text": "Follow us on social media",
- "links": [
]
}
], - "footer": {
- "text": "Powered by SpotLite sites"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "Preview",
- "domain": "jd-notary.pro",
- "versionId": "67ee0172690c0349c6a638fc"
}Updates a specific version of the page
| id required | string (pageId) Example: 67ee01ffd87a29376aeb52b1 Page ID |
| versionId required | string Version ID |
| clientId required | string [ 5 .. 50 ] characters Client ID |
| templateId required | string Template ID. This will be obtained from the templates endpoint |
| scriptUrl | string <uri> Custom script URL. The script will be loaded at the end of the page |
required | object Profile information |
required | Array of objects (LinkSectionSchema) non-empty Ordered list of sections |
object Footer information |
{- "clientId": "string",
- "templateId": "modern-01",
- "profile": {
- "name": "John Doe",
- "brandName": "JD Notary",
- "mobile": "5104567890",
- "bio": "I am a notary public with 10 years of experience",
- "address": "1234 Main St, San Francisco, CA 94105",
- "ctas": [
- {
- "type": "button",
- "title": "Book an Appointment",
- "icon": "calendar"
}
]
}, - "sections": [
- {
- "title": "Social",
- "text": "Follow us on social media",
- "links": [
]
}
], - "footer": {
- "text": "Powered by SpotLite sites"
}
}{- "id": "67ee01ffd87a29376aeb52b1",
- "clientId": "string",
- "templateId": "modern-01",
- "profile": {
- "name": "John Doe",
- "brandName": "JD Notary",
- "mobile": "5104567890",
- "bio": "I am a notary public with 10 years of experience",
- "address": "1234 Main St, San Francisco, CA 94105",
- "ctas": [
- {
- "type": "button",
- "title": "Book an Appointment",
- "icon": "calendar"
}
]
}, - "sections": [
- {
- "title": "Social",
- "text": "Follow us on social media",
- "links": [
]
}
], - "footer": {
- "text": "Powered by SpotLite sites"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "Preview",
- "domain": "jd-notary.pro",
- "versionId": "67ee0172690c0349c6a638fc"
}Publishes a specific page version content replacing the current published version.
This operation will only succeed if the page has a domain associated with it.
| id required | string (pageId) Example: 67ee01ffd87a29376aeb52b1 Page ID |
| versionId required | string Version ID |
{- "code": "PUBLISHING_ERROR",
- "message": "The page does not have a domain associated with it"
}Starts the image upload process for the page. This will return a signed URL to upload the image to the CDN.
This operation will immediately update the page preview with the new image URL (will show a default image until the actual upload is completed).
Any publihsed version will not be affected by this operation.
| id required | string (pageId) Example: 67ee01ffd87a29376aeb52b1 Page ID |
| versionId required | string Version ID |
Get the details of domain assigned to the page
| id required | string (pageId) Example: 67ee01ffd87a29376aeb52b1 Unique ID of the page |
{- "name": "jd-notary.pro",
- "status": "Registered",
- "createdAt": "2019-08-24T14:15:22Z",
- "expireDate": "2019-08-24T14:15:22Z",
- "renewalPrice": 0.1
}Check the availability of a domain.
The service will only check tlds that are supported by the service.
| id required | string (pageId) Example: 67ee01ffd87a29376aeb52b1 Unique ID of the page |
| domain required | string Domain name |
{- "name": "jd-notary.pro",
- "available": true,
- "purchasePrice": 0.1,
- "renewalPrice": 0.1
}Register a domain for the page
| id required | string (pageId) Example: 67ee01ffd87a29376aeb52b1 Unique ID of the page |
Domain name
{- "code": "REGISTRATION_ERROR",
- "message": "The specified domain is already registered"
}Search for available domains.
This will return a list of available domains based on the search query and the pages profile information.
The service will only return tlds that are supported by the service.
| id required | string (pageId) Example: 67ee01ffd87a29376aeb52b1 Unique ID of the page |
| domain required | string |
[- {
- "name": "jd-notary.pro",
- "available": true,
- "purchasePrice": 0.1,
- "renewalPrice": 0.1
}
]Search for available domains.
This will stream a list of available domains based on the search query and the pages profile information.
The service will only return tlds that are supported by the service.
| id required | string (pageId) Example: 67ee01ffd87a29376aeb52b1 Unique ID of the page |
| domain required | string |
{- "code": 400,
- "message": "Invalid request"
}Setup email forwarding for the page
This will forward all emails sent to the new email address to the existing email address.
| id required | string (pageId) Example: 67ee01ffd87a29376aeb52b1 Unique ID of the page |
Email forwarding details
| emailBox required | string New email address will be |
| emailForwardTo required | string <email> |
{- "emailBox": "john.doe",
- "emailForwardTo": "[email protected]"
}{- "code": 400,
- "message": "Invalid request"
}