Update organization-level Connect configuration

PUT

/v2/organizations/:organizationId/connect/:connectId

PUT

/Management/v2/organizations/:organizationId/connect/:connectId

curl -X PUT https://api-d.docusign.net/Management/v2/organizations/organizationId/connect/connectId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

200Updated

{
  "connectId": "00000000-0000-0000-0000-000000000000",
  "configurationType": "string",
  "allowEnvelopePublish": "string",
  "urlToPublishTo": "string",
  "deliveryMode": "string",
  "events": [
    "string"
  ],
  "associatedFilterSelection": "string",
  "accountIds": [
    "string"
  ],
  "userIds": [
    "string"
  ],
  "groupIds": [
    "string"
  ],
  "name": "string",
  "signMessageWithX509Certificate": "string",
  "includeOAuth": "string",
  "includeHMAC": "string",
  "pausePublish": "string",
  "eventData": {
    "version": "string",
    "includeData": [
      "string"
    ]
  }
}

Updates the specified Organization-Level Connect configuration to the values provided in the request body definition. See Enable OAuth for Connect for an example Connect definition.

Required scopes: connect_org_config_write_api

Authentication

AuthorizationBearer

OAuth2 Access code Grant

Path parameters

organizationIdstringRequiredformat: "uuid"

The GUID ID of the organization where the Organization-Level Connect configuration is defined.

connectIdstringRequiredformat: "uuid"

The GUID ID of the Organization-Level Connect configuration to update.

Request

This endpoint expects an object: connectRequest

connectIdstringOptionalformat: "uuid"

configurationTypestringOptional

allowEnvelopePublishstringOptional

urlToPublishTostringOptional

deliveryModestringOptional

eventslist of stringsOptional

associatedFilterSelectionstringOptional

groupIdslist of stringsOptional

accountIdslist of stringsOptional

userIdslist of stringsOptional

namestringOptional

signMessageWithX509CertificatestringOptional

includeOAuthstringOptional

includeHMACstringOptional

pausePublishstringOptional

eventDataobjectOptional

Response