M3m3ter-com
IntegrationConfigs

Enable IntegrationConfig

Changed on

Enables a previously disabled integration configuration, allowing it to be operational again.

post/organizations/{orgId}/integrationconfigs/{id}/enable

Request

Path parameters

orgIdstring required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

idstring required

UUID of the integration configuration

Response

Returns the IntegrationConfig

idstring required

The UUID of the entity.

versioninteger

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
dtCreatedstring date-time

The DateTime when this item was created (in ISO-8601 format).

dtLastModifiedstring date-time

The DateTime when this item was last modified (in ISO-8601 format).

createdBystring

The ID of the user who created this item.

lastModifiedBystring

The ID of the user who last modified this item.

entityTypestring required

The type of entity the integration is for (e.g. Bill).

entityIdstring

The unique identifier (UUID) of the entity this integration is for (e.g. the ID of a notification configuration. Optional.)

destinationstring required

The type of destination (e.g. Netsuite, webhooks).

destinationIdstring

The unique identifier (UUID) of the entity the integration is for.

configDataobject

Configuration data for the integration

authorizedboolean

A flag indicating whether the integration configuration is authorized.

  • TRUE - authorized.
  • FALSE - not authorized.
enabledboolean

A flag indicating whether the integration configuration is currently enabled or disabled.

  • TRUE - enabled.
  • FALSE - disabled.
triggerType'EVENT' | 'SCHEDULE'

Specifies the type of trigger for the integration.

integrationCredentialsIdstring

UUID of the credentials to use for this integration

namestring

The name of the configuration

Example response

{
  "entityType": "Bill",
  "entityId": "00000000-0000-0000-0000-000000000000",
  "destination": "Stripe",
  "destinationId": "00000000-0000-0000-0000-000000000000",
  "integrationCredentialsId": "00000000-0000-0000-0000-000000000000",
  "name": "My Integration"
}

Changes

  • 85c514abc692Revision changes
    • breaking

      the //// response's property type changed from no type to object for status

    • breaking

      the response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the // response's property type changed from no type to object for status

    • info

      api tag IntegrationConfigs added

    • info

      api tag Integrations removed

  • 0f92c877619fRevision changes
    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status