APIs to onboard and manage company.
Company API (v2)
Download OpenAPI description
Languages
Servers
Sandbox URL
https://api-ext-sboxmeta.partners.spotnana.com
Spotnana mock server
https://developer.spotnana.com/_mock/openapi/companyapi
Bodyapplication/jsonrequired
List of terms and conditions. Each item is rich text that renders a bullet point with text and link.
Example: ["I agree to the <a href=\"https://www.spotnana.com/terms/\">Terms of Service</a>","I agree to the <a href=\"https://www.spotnana.com/privacy/\">Privacy Policy</a>"]
Login action types assigned to users created via enrollment.
Items Enum"PRIVACY_CONSENT_ACTION""ONBOARDING_ACTION""HYATT_LOYALTY_VALIDATION"
Configuration for company-specified attributes on the enrollment form.
- Sandbox URLhttps://api-ext-sboxmeta.partners.spotnana.com/v2/companies/{companyId}/enrollment-config
- Spotnana mock serverhttps://developer.spotnana.com/_mock/openapi/companyapi/v2/companies/{companyId}/enrollment-config
- curl
- JavaScript
- Node.js
- Python
curl -i -X PUT \
https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/enrollment-config \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"termsAndConditions": "https://www.spotnana.com/terms/",
"termsAndConditionsList": [
"I agree to the <a href=\"https://www.spotnana.com/terms/\">Terms of Service</a>",
"I agree to the <a href=\"https://www.spotnana.com/privacy/\">Privacy Policy</a>"
],
"templateSettings": {
"applicationReceivedTemplate": "string",
"applicationRejectedTemplate": "string",
"applicationApprovedTemplate": "string"
},
"industryDropdownOptions": [
"string"
],
"skipOfacComplianceCheck": true,
"registrarLoginActions": [
"PRIVACY_CONSENT_ACTION"
],
"companySpecifiedAttributeConfigs": [
{
"name": "string",
"isHidden": false
}
]
}'- Sandbox URLhttps://api-ext-sboxmeta.partners.spotnana.com/v2/companies/{companyId}/enrollment-config
- Spotnana mock serverhttps://developer.spotnana.com/_mock/openapi/companyapi/v2/companies/{companyId}/enrollment-config
- curl
- JavaScript
- Node.js
- Python
curl -i -X GET \
https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/enrollment-config \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'OK
List of terms and conditions. Each item is rich text that renders a bullet point with text and link.
Example: ["I agree to the <a href=\"https://www.spotnana.com/terms/\">Terms of Service</a>","I agree to the <a href=\"https://www.spotnana.com/privacy/\">Privacy Policy</a>"]
Login action types assigned to users created via enrollment.
Items Enum"PRIVACY_CONSENT_ACTION""ONBOARDING_ACTION""HYATT_LOYALTY_VALIDATION"
Configuration for company-specified attributes on the enrollment form.
Response
application/json
{ "termsAndConditions": "https://www.spotnana.com/terms/", "termsAndConditionsList": [ "I agree to the <a href=\"https://www.spotnana.com/terms/\">Terms of Service</a>", "I agree to the <a href=\"https://www.spotnana.com/privacy/\">Privacy Policy</a>" ], "templateSettings": { "applicationReceivedTemplate": "string", "applicationRejectedTemplate": "string", "applicationApprovedTemplate": "string" }, "industryDropdownOptions": [ "string" ], "skipOfacComplianceCheck": true, "registrarLoginActions": [ "PRIVACY_CONSENT_ACTION" ], "companySpecifiedAttributeConfigs": [ { … } ] }