---
title: "Update sync"
method: PATCH
path: "/api/{cloudId}/v1/syncs/{id}"
tags: ["Syncs"]
---

# Update sync

`PATCH /api/{cloudId}/v1/syncs/{id}`

Updates a sync. 
- The user should have edit permission for sync.

## Path parameters

- `id` string, required — Id of the sync.

## Request body

- UpdateSyncDto
  - `name` string — Name of the sync. Name must be unique for each sync.
  - `description` string — Description of the sync.
  - `enabled` boolean — This parameter is for specifying whether the integration will be enabled or not.
  - `teamId` string — Owner team of the sync, consisting id of the owner team.
  - `properties` object — Sync specific properties may be provided to this object. For instance, this map should consist - *projectKey*

## Response `200`

Returned if the request is successful

- SyncMetadata — List of syncs.
  - `id` string — Id of the sync.
  - `name` string — Name of the sync.
  - `type` string — Type of the sync. (For instance, "jira-software-cloud" for Jira Software Cloud Sync.)
  - `enabled` boolean — This parameter is for specifying whether the sync will be enabled or not. Defaults to false
  - `teamId` string — Owner team of the sync, consisting id of the owner team.

## Other responses

- `401` — Returned if the authentication credentials are incorrect
- `403` — Returned if the request user does not have permission to edit the sync or operation is not allowed.
- `422` — Returned if the payload is not validated

---

[API](https://skmtc.net/atlassian/apis/jsm-operations-api.md) · [All operations](https://skmtc.net/atlassian/apis/jsm-operations-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/jsm-operations-api/versions/ed65f017bcb8/schema)