Integrations

Update an integration

Update an integration by its unique key identifier integrationId. Each provider supports different credentials, check the provider documentation for more details. Only integration metadata is returned, credentials field is returned as an empty object.

put/v1/integrations/{integrationId}

Request

  • Base URL: https://api.notifly.io
  • URL: https://api.notifly.io/v1/integrations/{integrationId}
  • Auth: API key in header Authorization

Path parameters

integrationIdstring required

Request body

namestring
identifierstring
_environmentIdstring
activeboolean

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

checkboolean
rulesobject nullable

JSONLogic used at send time to select this integration. Takes precedence over conditions.

configurationsobject

Configurations for the integration

Example request

{
  "rules": {
    "==": [
      {
        "var": "context.tenant.id"
      },
      "acme"
    ]
  }
}

Response

OK

Example response

{
  "data": {
    "rules": {
      "==": [
        {
          "var": "context.tenant.id"
        },
        "acme"
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.