ATatlassian
Syncs

Update sync

Updates a sync.

  • The user should have edit permission for sync.
patch/api/{cloudId}/v1/syncs/{id}

Request

  • Base URL
    https://api.atlassian.com/jsm/ops
  • URL
    https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/syncs/{id}
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.stg.atlassian.com/authorize
      Token URL: https://auth.stg.atlassian.com/oauth/token scopes: read:ops-config:jira-service-management, write:ops-config:jira-service-management

Path parameters

idstring required

Id of the sync.

Request body

namestring

Name of the sync. Name must be unique for each sync.

descriptionstring

Description of the sync.

enabledboolean

This parameter is for specifying whether the integration will be enabled or not.

teamIdstring

Owner team of the sync, consisting id of the owner team.

propertiesobject

Sync specific properties may be provided to this object. For instance, this map should consist

  • projectKey

Response

Returned if the request is successful

idstring

Id of the sync.

namestring

Name of the sync.

typestring

Type of the sync. (For instance, "jira-software-cloud" for Jira Software Cloud Sync.)

enabledboolean

This parameter is for specifying whether the sync will be enabled or not. Defaults to false

teamIdstring

Owner team of the sync, consisting id of the owner team.

Changes

No recorded changes to this operation across all 5 revisions of this API.