Subscribe to Documents push notification

PUT /api/2.0/settings/push/docsubscribe

Request

Subscribes to the Documents push notification.

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, text/json.

Body

Firebase request parameters

firebaseDeviceTokenstring

Firebase device token

isSubscribedboolean

Specifies if the user is subscribed to the push notification or not

Examples

PUT /api/2.0/settings/push/docsubscribe HTTP/1.1
Accept: application/json
Content-Length: 64
Content-Type: application/json
Host: example.com

{
  "firebaseDeviceToken": "some text",
  "isSubscribed": true
}

curl --request PUT \
  --url https://example.com/api/2.0/settings/push/docsubscribe \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "firebaseDeviceToken": "some text",
  "isSubscribed": true
}'

Responses

200

FireBase user

idintegerformat: int32

userIdstringformat: uuid

tenantIdintegerformat: int32

firebaseDeviceTokenstring

applicationstring

isSubscribedboolean

tenantobject

idintegerformat: int32

namestring

aliasstring

mappedDomainstring

versionintegerformat: int32

version_Changedstringformat: date-time

versionChangedstringformat: date-time

languagestring

timeZonestring

trustedDomainsRawstring

trustedDomainsEnabledone of

.enum of string

[None - None, Custom - Custom, All - All]

Can be one of: None, Custom, All.

.enum of integer

[0 - None, 1 - Custom, 2 - All]

Can be one of: 0, 1, 2.

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.

statusChangedstringformat: date-time

statusChangedHackstringformat: date-time

creationDateTimestringformat: date-time

ownerIdstringformat: uuid

paymentIdstring

industryone of

.enum of string

[Other - Other, Accounting - Accounting, AdvertisingMarketingPR - Advertising marketing PR, Banking - Banking, Consulting - Consulting, Design - Design, Education - Education, Environment - Environment, FinancialServices - Financial services, HealthCare - Health care, IT - IT, Legal - Legal, Manufacturing - Manufacturing, PublicSector - Public sector, Publishing - Publishing, RetailSales - Retail sales, Telecommunications - Telecommunications]

Can be one of: Other, Accounting, AdvertisingMarketingPR, Banking, Consulting, Design, Education, Environment, FinancialServices, HealthCare, IT, Legal, Manufacturing, PublicSector, Publishing, RetailSales, Telecommunications.

.enum of integer

[0 - Other, 1 - Accounting, 2 - Advertising marketing PR, 3 - Banking, 4 - Consulting, 5 - Design, 6 - Education, 7 - Environment, 8 - Financial services, 9 - Health care, 10 - IT, 11 - Legal, 12 - Manufacturing, 13 - Public sector, 14 - Publishing, 15 - Retail sales, 16 - Telecommunications]

Can be one of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16.

lastModifiedstringformat: date-time

spamboolean

callsboolean

partnerobject

tenantIdintegerformat: int32

partnerIdstring

affiliateIdstring

campaignstring

401

Unauthorized

403

Forbidden