PUT
/
v1
/
integrations
/
{integrationId}
curl --request PUT \
  --url https://api.novu.co/v1/integrations/{integrationId} \
  --header 'Content-Type: application/json' \
  --data '{
  "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>"
  },
  "check": true,
  "conditions": [
    {
      "isNegated": true,
      "type": "BOOLEAN",
      "value": "AND",
      "children": [
        {
          "field": "<string>",
          "value": "<string>",
          "operator": "LARGER",
          "on": "subscriber"
        }
      ]
    }
  ]
}'
{
  "data": {
    "_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>"
    },
    "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"
          }
        ]
      }
    ]
  }
}

Path Parameters

​
integrationId
string
required

Body

application/json
​
name
string
​
identifier
string
​
_environmentId
string
​
active
boolean

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

​
credentials
object
​
check
boolean
​
conditions
object[]

Response

200
application/json
Ok
​
data
object

Was this page helpful?

Suggest editsRaise issue