---
title: "Create link"
method: POST
path: "/links"
tags: ["Links"]
---

# Create link

`POST /links`

Create a link. You must supply either `pattern` or `external_url` in the request, but not both (`pattern` is for application objects while `external_url` is for standard links). If `pattern` is provided, the API call updates the application objects matching the exact pattern. Keep in mind this endpoint only creates or updates an existing link from an application object. It does not create new application objects. If the link is resolved to an installed links integration, any name retrieved from the integration will override the provided name in the request.

Required scope: `links:write`

## Request body

- CreateLink — A link is used to connect a Front conversation to an external resource.
  - `name` string — Name of the link. If none is specified, the external_url is used as a default
  - `external_url` string — Underlying identifying url of the link
  - `pattern` string — The string that application object configurations will match on to update a specific application object. For example, if you've configured an application object to match on ORDER-{Digits}, and you want to specifically update the application objects for ORDER-777 to retrieve the latest information from external systems, send "ORDER-777". Repeat for other specific identifiers, such as "ORDER-435".

## Response `201`

A link

- LinkResponse — A link used to connect a Front conversation to an external resource.
  - `_links` object, required
    - `self` string — Link to resource
  - `id` string, required — Unique identifier of the link
  - `name` string, required — Display name of the link
  - `type` string, required — Type of the link. Typically associated with the underlying link provider (if known)
  - `external_url` string, required — Underlying identifying external URL of the link
  - `custom_fields` CustomFieldParameter, required — An object whose key is the `name` property defined for the custom field in the Front UI. The value of the key must use the same `type` specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields

---

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