> ## Documentation Index
> Fetch the complete documentation index at: https://help.airbridge.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 소셜 쉐어 프리뷰 수정하기

HTTP Method PATCH, PUT 을 지원합니다.

트래킹 링크의 [소셜 쉐어 프리뷰](/ko/guides/social-share-preview)를 수정합니다.

<Card title="Try API Request" icon="rectangle-api" horizontal href="https://www.postman.com/airbridge-engineering/workspace/airbridge-api/request/22395869-7a210890-a01a-475c-b526-9616a3ea49f4" />

```text PATCH theme={"theme":{"light":"github-dark-dimmed","dark":"github-dark-dimmed"}}
https://api.airbridge.io/v1/tracking-links/{id}/og-tag
```

<h2 id="소셜-쉐어-프리뷰-수정하기-request">
  Request
</h2>

***

<h3 id="소셜-쉐어-프리뷰-수정하기-headers">
  Headers
</h3>

<ParamField header="Accept-Language" type="string">
  API 요청 및 결과 반환에 사용할 언어를 지정할 수 있습니다. ISO-639-1 포맷을 따릅니다.
</ParamField>

<ParamField header="Content-Type" type="string">
  리소스의 미디어 타입을 나타냅니다. 기본값으로 `application/json`을 사용합니다.
</ParamField>

<ParamField header="Authorization" type="string">
  API 요청에 사용하는 키값입니다. [키값 생성 및 조회 방법](/ko/references/introduction)을 확인하여 획득할 수 있습니다.
</ParamField>

<h3 id="소셜-쉐어-프리뷰-수정하기-path-params">
  Path Params
</h3>

<ParamField path="id" type="string" required>
  트래킹 링크 식별자. `idType`를 활용하면 트래킹 링크 식별자로 트래킹 링크 ID 대신 숏 링크 ID와 트래킹 링크 템플릿 ID를 사용할 수 있습니다. `idType`을 입력하지 않으면 트래킹 링크 식별자로 트래킹 링크 ID를 사용합니다.

  트래킹 링크 ID는 목록 가져오기 API를 통해 확인할 수 있습니다. 숏 링크 ID와 트래킹 링크 템플릿 ID는 에어브릿지 대시보드에서 확인할 수 있습니다.
</ParamField>

<h3 id="소셜-쉐어-프리뷰-수정하기-body-params">
  Body Params
</h3>

<ParamField body="idType" type="string">
  트래킹 링크 식별자의 형식. 기본 설정은 `id`입니다.

  * `id`: 일반적인 트래킹 링크의 식별자입니다. 목록 가져오기 API를 통해 확인할 수 있습니다.
  * `shortId`:  숏 링크 ID입니다. 숏 링크는 숏 링크 형식의 트래킹 링크입니다.
  * `trackingTemplateId`: 트래킹 링크 템플릿의 ID입니다.
</ParamField>

<ParamField body="title" type="string" required>
  트래킹 링크의 `og:title`
</ParamField>

<ParamField body="description" type="string" required>
  트래킹 링크의 `og:description`
</ParamField>

<ParamField body="imageUrl" type="string" required>
  트래킹 링크의 `og:image`
</ParamField>

<ParamField body="ogTag.websiteCrawl" type="enum">
  `fallbackPath`에 지정된 url의 Open Graph를 트래킹 링크의 Open Graph로 타입.

  | 벨류        | 설명                                                                                                                                                                                                                        |
  | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `desktop` | 트래킹 링크가 소셜 미디어에 공유될 때 소셜 미디어가 fallbackPaths에 지정된 desktop URL의 Open Graph 태그를 직접 크롤링해 소셜 쉐어 프리뷰에 사용합니다. 동적(Dynamic) URL도 지원하며, Open Graph 태그의 변경 사항은 다음 공유 시점부터 자동으로 반영됩니다. 이때 title, description, imageUrl로 설정한 값은 무시됩니다. |
</ParamField>

<ParamField body="ogTag.useDefault" type="boolean">
  Airbridge 대시보드에서 설정한 소셜쉐어 프리뷰 기본 값을 사용하도록 설정 합니다.

  주의. og tag 의 다른 파라미터 값들은 무시됩니다.
</ParamField>

<RequestExample>
  ```shellscript Request theme={"theme":{"light":"github-dark-dimmed","dark":"github-dark-dimmed"}}
  curl -X PATCH 'https://api.airbridge.io/v1/tracking-links/10000/og-tag' \
    -H 'Accept-Language: ko' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
    -d '{
    "idType": "id",
    "title": "30% Off Winter Apparel for 3 Days Only",
    "description": "Get great deals on apparel to keep you warm this winter",
    "imageUrl": "https://static.airbridge.io/images/2021_airbridge_og_tag.png"
  }'
  ```
</RequestExample>

<h2 id="소셜-쉐어-프리뷰-수정하기-response">
  Response
</h2>

***

### 200

### 400

image URL 이 올바르지 않은 URL 형태를 사용한 경우.

### 404

입력한 필드에 오류가 있거나 해당하는 리소스가 없습니다.

<ResponseExample>
  ```json 200 theme={"theme":{"light":"github-dark-dimmed","dark":"github-dark-dimmed"}}
  {}
  ```

  ```json 400 theme={"theme":{"light":"github-dark-dimmed","dark":"github-dark-dimmed"}}
  {
    "instance": [
      {
        "loc": [
          "imageUrl"
        ],
        "msg": "Invalid URL",
        "type": "validation_error"
      }
    ],
    "detail": "invalid_request",
    "status": 400,
    "title": "Bad Request",
    "traceId": "1-67c6a5e8-1f93748e2c8c732e71767b98",
    "type": "about:blank"
  }
  ```

  ```json 404 theme={"theme":{"light":"github-dark-dimmed","dark":"github-dark-dimmed"}}
  {
    "type": "about:blank",
    "title": "Not Found",
    "detail": "Resource not found.",
    "status": 404,
    "traceId": "1-6450a21d-2b02e4d533589b625d875399"
  }
  ```
</ResponseExample>