Update an app integration push notification

Update an app integration push notification by the given id.

put

Path parameters

idstringRequired

The id of the app integration push notification.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

The request data transfer object for the push notification integration when updating.

appIntegrationIdstring · min: 1Required

The app integration provider ID of the push notification.

codestring · min: 1Required

The code of the push notification.

namestring · min: 1Required

The name of the push notification.

projectIdstring · min: 1Required

The project ID of the push notification.

clientEmailstring · min: 1Required

The client email of the push notification.

clientIdstring | nullableOptional

The client ID of the push notification.

privateKeystring · min: 1Required

The private key of the push notification.

authURLstring · uri | nullableOptional

The authentication URL of the push notification.

tokenURLstring · uri | nullableOptional

The token URL of the push notification.

authProviderX509CertURLstring · uri | nullableOptional

The authentication provider X509 certificate URL of the push notification.

clientX509CertURLstring · uri | nullableOptional

The client X509 certificate URL of the push notification.

universeDomainstring | nullableOptional

The universe domain of the push notification.

apiKeystring | nullableOptional

The API key of the push notification.

authDomainstring | nullableOptional

The authentication domain of the push notification.

storageBucketstring | nullableOptional

The storage bucket of the push notification.

messagingSenderIdstring | nullableOptional

The messaging sender ID of the push notification.

appIdstring | nullableOptional

The app ID of the push notification. Use projectId instead if using Firebase service.

measurementIdstring | nullableOptional

The measurement ID of the push notification.

vapidKeystring | nullableOptional

The VAPID key of the push notification.

isDefaultbooleanOptional

Flag to indicate if the push notification integration is the default. Default is false.

statusstring · enumOptional

This enum is used to define the common status of an object in JFW.

Supported values:

Possible values:

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

403

The user's access was denied.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v1/app-integrations/push-notification/{id} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 491

{
  "appIntegrationId": "text",
  "code": "text",
  "name": "text",
  "projectId": "text",
  "clientEmail": "text",
  "clientId": "text",
  "privateKey": "text",
  "authURL": "https://example.com",
  "tokenURL": "https://example.com",
  "authProviderX509CertURL": "https://example.com",
  "clientX509CertURL": "https://example.com",
  "universeDomain": "text",
  "apiKey": "text",
  "authDomain": "text",
  "storageBucket": "text",
  "messagingSenderId": "text",
  "appId": "text",
  "measurementId": "text",
  "vapidKey": "text",
  "isDefault": true,
  "status": "Inactive"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": [
    {
      "appIntegration": {
        "type": "PaymentGateway",
        "name": "Stripe",
        "domain": "https://stripe.com",
        "description": "Stripe payment gateway",
        "logoURL": null,
        "status": "Active",
        "id": "sApKpllz4sAplsmzha"
      },
      "status": "Active",
      "isDefault": false,
      "vapidKey": "vapid-key",
      "measurementId": "measurement-id",
      "appId": "app-id",
      "messagingSenderId": "messaging-sender-id",
      "storageBucket": "storage-bucket",
      "authDomain": "auth-domain",
      "apiKey": "api-key",
      "id": "sApKpllz4sAplsmzha",
      "universeDomain": "universe-domain",
      "authProviderX509CertURL": "auth-provider-x509-cert-url",
      "tokenURL": "token-url",
      "authURL": "auth-url",
      "privateKey": "private-key",
      "clientId": "client-id",
      "clientEmail": "client-email",
      "projectId": "project-id",
      "name": "name",
      "code": "code",
      "clientX509CertURL": "client-x509-cert-url"
    }
  ],
  "errors": []
}