Update a third-party link

Updates the properties (title, type, or URL) of an existing third-party link

PATCH/api/v1/{team_slug}/{app_slug}/third-party-links/{third_party_link_id}

API: Management
OpenAPI: management-api
Updated: Apr 26, 2026

management-api:PATCH:/api/v1/{team_slug}/{app_slug}/third-party-links/{third_party_link_id}

Updates the properties (title, type, or URL) of an existing third-party link

API ownership

API family: Management API
Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
Do not use from: Browser-only storefront code or public clients.
Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

Method: PATCH
Path: /api/v1/\{team_slug\}/\{app_slug\}/third-party-links/\{third_party_link_id\}
Summary: Update a third-party link
Description: Updates the properties (title, type, or URL) of an existing third-party link
OpenAPI contract: management-api
Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters3 parameters

Name	In	Required	Type	Description
app_slug	path	Yes	string	App slug
team_slug	path	Yes	string	Team slug
third_party_link_id	path	Yes	string	Third-party link ID

Request bodyDocumented body

Required: Yes
Description: Third-party link update data
Content: application/json (object)

Input Update Third Party Link

Property	Type	Required	Details
`title`	string	Yes	-
`type`	enum("image", "video", "link")	No	-
`url`	string	No	-

Generated example (synthetic):

{
  "title": "string",
  "type": "image",
  "url": "string"
}

Responses5 statuses

Status	Description	Content
200	Third-party link updated successfully	application/json (object)
400	Invalid request (e.g., bad UUID, validation error)	application/json (object)
401	Unauthorized access	application/json (object)
404	Third-party link not found	application/json (object)
500	Internal server error	application/json (object)

200 - object

Third Party Link Response

Property	Type	Required	Details
`data`	object	No	-
`details`	string[]	No	Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
`success`	boolean	No	-

Third Party Link

Property	Type	Required	Details
`created_at`	string	No	-
`id`	string	No	-
`title`	string	No	-
`type`	string	No	-
`updated_at`	string	No	-
`url`	string	No	-

Generated example (synthetic):

{
  "data": {
    "created_at": "string",
    "id": "string",
    "title": "string",
    "type": "string",
    "updated_at": "string",
    "url": "string"
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

404 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

API family: Management API
Method: PATCH
Path: /api/v1/\{team_slug\}/\{app_slug\}/third-party-links/\{third_party_link_id\}
Operation ID: Not documented in the OpenAPI contract.
OpenAPI tag: Third Party Link
OpenAPI summary: Update a third-party link