Checks if portal exists

POST /portal/validateportalname

Request

Checks if portal exists

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, application/*+xml, application/xml, text/json, text/xml.

Body

Request parameters for portal

portalNamestring

Portal name

tenantIdintegerformat: int32

Tenant id

affiliateIdstring

Affiliate id

partnerIdstring

Partner id

campaignstring

Campaign

firstNamestring

First name

emailstringformat: email

Email

industryintegerformat: int32

Industry

languagestring

Language

lastNamestring

Last name

modulestring

Module

passwordstring

Password

passwordHashstring

Password hash

phonestring

Phone

recaptchaResponsestring

Recaptcha response

recaptchaTypeone of

.enum of string

[Default - Default, AndroidV2 - AndroidV2, iOSV2 - iOSV2, hCaptcha - hCaptcha]

Can be one of: Default, AndroidV2, iOSV2, hCaptcha.

.enum of integer

[0 - Default, 1 - AndroidV2, 2 - iOSV2, 3 - hCaptcha]

Can be one of: 0, 1, 2, 3.

regionstring

Region

awsRegionstring

AWS region

statusone of

.enum of string

[Active - Active, Suspended - Suspended, RemovePending - Remove pending, Transfering - Transfering, Restoring - Restoring, Migrating - Migrating, Encryption - Encryption]

Can be one of: Active, Suspended, RemovePending, Transfering, Restoring, Migrating, Encryption.

.enum of integer

[0 - Active, 1 - Suspended, 2 - Remove pending, 3 - Transfering, 4 - Restoring, 5 - Migrating, 6 - Encryption]

Can be one of: 0, 1, 2, 3, 4, 5, 6.

skipWelcomeboolean

Skip welcome

timeZoneNamestring

TimeZone name

spamboolean

Spam

callsboolean

Calls

appKeystring

App key

limitedAccessSpaceboolean

Limited access space

Examples

POST /portal/validateportalname HTTP/1.1
Accept: application/json
Content-Length: 612
Content-Type: application/json
Host: example.com

{
  "portalName": "some text",
  "tenantId": 1234,
  "affiliateId": "some text",
  "partnerId": "some text",
  "campaign": "some text",
  "firstName": "Mose",
  "email": "Kameron_Medhurst@yahoo.com",
  "industry": 1234,
  "language": "some text",
  "lastName": "Nikolaus",
  "module": "some text",
  "password": "uRMhABtY6s",
  "passwordHash": "some text",
  "phone": "some text",
  "recaptchaResponse": "some text",
  "region": "some text",
  "awsRegion": "some text",
  "skipWelcome": true,
  "timeZoneName": "some text",
  "spam": true,
  "calls": true,
  "appKey": "some text",
  "limitedAccessSpace": true
}

curl --request POST \
  --url https://example.com/portal/validateportalname \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "portalName": "some text",
  "tenantId": 1234,
  "affiliateId": "some text",
  "partnerId": "some text",
  "campaign": "some text",
  "firstName": "Mose",
  "email": "Kameron_Medhurst@yahoo.com",
  "industry": 1234,
  "language": "some text",
  "lastName": "Nikolaus",
  "module": "some text",
  "password": "uRMhABtY6s",
  "passwordHash": "some text",
  "phone": "some text",
  "recaptchaResponse": "some text",
  "region": "some text",
  "awsRegion": "some text",
  "skipWelcome": true,
  "timeZoneName": "some text",
  "spam": true,
  "calls": true,
  "appKey": "some text",
  "limitedAccessSpace": true
}'

Responses

200

Ok

401

Unauthorized