DocumentationDocumentation
DocumentationFrameworkCommunityAPI Reference
Sign InSign Up

GitHubnovuhq/novu

36343

Update integration

PUT/v1/integrations/{integrationId}

Authorization

Authorization<token>

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

In: header

Request Body

application/jsonRequired
namestring
identifierstring
_environmentIdstring
activeboolean

If the integration is active the validation on the credentials field will run

credentialsobject
removeNovuBrandingboolean

If true, the Novu branding will be removed from the Inbox component

checkboolean
conditionsarray<object>

Path Parameters

integrationIdRequiredstring

Header Parameters

idempotency-keystring

A header for idempotency purposes

curl -X PUT "https://api.novu.co/v1/integrations/<string>" \
  -H "idempotency-key: <string>" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "identifier": "string",
    "_environmentId": "string",
    "active": true,
    "credentials": {
      "apiKey": "string",
      "user": "string",
      "secretKey": "string",
      "domain": "string",
      "password": "string",
      "host": "string",
      "port": "string",
      "secure": true,
      "region": "string",
      "accountSid": "string",
      "messageProfileId": "string",
      "token": "string",
      "from": "string",
      "senderName": "string",
      "projectName": "string",
      "applicationId": "string",
      "clientId": "string",
      "requireTls": true,
      "ignoreTls": true,
      "tlsOptions": {},
      "baseUrl": "string",
      "webhookUrl": "string",
      "redirectUrl": "string",
      "hmac": true,
      "serviceAccount": "string",
      "ipPoolName": "string",
      "apiKeyRequestHeader": "string",
      "secretKeyRequestHeader": "string",
      "idPath": "string",
      "datePath": "string",
      "apiToken": "string",
      "authenticateByToken": true,
      "authenticationTokenKey": "string",
      "instanceId": "string",
      "alertUid": "string",
      "title": "string",
      "imageUrl": "string",
      "state": "string",
      "externalLink": "string",
      "channelId": "string",
      "phoneNumberIdentification": "string",
      "accessKey": "string"
    },
    "removeNovuBranding": true,
    "check": true,
    "conditions": [
      {
        "isNegated": true,
        "type": "BOOLEAN",
        "value": "AND",
        "children": [
          {
            "field": "string",
            "value": "string",
            "operator": "LARGER",
            "on": "subscriber"
          }
        ]
      }
    ]
  }'

OK

{
  "_id": "string",
  "_environmentId": "string",
  "_organizationId": "string",
  "name": "string",
  "identifier": "string",
  "providerId": "string",
  "channel": "in_app",
  "credentials": {
    "apiKey": "string",
    "user": "string",
    "secretKey": "string",
    "domain": "string",
    "password": "string",
    "host": "string",
    "port": "string",
    "secure": true,
    "region": "string",
    "accountSid": "string",
    "messageProfileId": "string",
    "token": "string",
    "from": "string",
    "senderName": "string",
    "projectName": "string",
    "applicationId": "string",
    "clientId": "string",
    "requireTls": true,
    "ignoreTls": true,
    "tlsOptions": {},
    "baseUrl": "string",
    "webhookUrl": "string",
    "redirectUrl": "string",
    "hmac": true,
    "serviceAccount": "string",
    "ipPoolName": "string",
    "apiKeyRequestHeader": "string",
    "secretKeyRequestHeader": "string",
    "idPath": "string",
    "datePath": "string",
    "apiToken": "string",
    "authenticateByToken": true,
    "authenticationTokenKey": "string",
    "instanceId": "string",
    "alertUid": "string",
    "title": "string",
    "imageUrl": "string",
    "state": "string",
    "externalLink": "string",
    "channelId": "string",
    "phoneNumberIdentification": "string",
    "accessKey": "string"
  },
  "active": true,
  "deleted": true,
  "deletedAt": "string",
  "deletedBy": "string",
  "primary": true,
  "conditions": [
    {
      "isNegated": true,
      "type": "BOOLEAN",
      "value": "AND",
      "children": [
        {
          "field": "string",
          "value": "string",
          "operator": "LARGER",
          "on": "subscriber"
        }
      ]
    }
  ]
}

Edit on GitHub

Previous

Set integration as primary POST