---
title: "Create a task external link"
method: POST
path: "/companies/{company}/tasks/{task}/external-links"
tags: ["Tasks"]
---

# Create a task external link

`POST /companies/{company}/tasks/{task}/external-links`

## Request

- Base URL: `https://api.factuarea.com/v1`
- URL: `https://api.factuarea.com/v1/companies/{company}/tasks/{task}/external-links`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Add a link to an external resource (`url`, `http` or `https`, with an optional `title`) to a task. Adding the same URL again returns the existing link.

## Path parameters

- `company` string, uuid, required
- `task` string, uuid, required

## Headers

- `Idempotency-Key` string
- `Factuarea-Version` string, date

## Request body

- AddTaskExternalLinkV1Request
  - `url` string, uri, required: `http` or `https` URL of the link, at most 2,048 characters and without credentials.
  - `title` string, nullable: Optional title of the link, at most 200 characters.

## Response `201`

- object
  - `data` TaskExternalLink, required: A link from a task to an external resource: added by hand, or synchronized from a code forge.
    - `id` string, uuid, required: UUID v7 of the link.
    - `object` 'task_external_link', required: Stripe-like discriminator. Always `task_external_link` for this resource.
    - `task_id` string, uuid, required: UUID of the task.
    - `url` string, uri, required
    - `title` string, nullable, required
    - `resource_type` 'url' | 'issue' | 'pull_request' | 'branch', required: `url` for links added by hand; the forge resource otherwise.
    - `integration_id` string, uuid, nullable, required: UUID of the forge integration that manages the link, or `null` when added by hand.
    - `integration_type` 'github' | 'gitlab' | 'gitea' | 'null', nullable, required: Forge of that integration, or `null`.
    - `created_at` string, date-time, required: Creation timestamp.

## Other responses

- `400`: `parameter_unknown` with `subcode` `retired_active_profile_header`: the retired `X-Active-Profile` header was sent; the company goes in the path. `parameter_invalid_format` on `Factuarea-Version`: the header is not a `YYYY-MM-DD` date. `unsupported_api_version`: the `Factuarea-Version` date is not a supported version.
- `401`: Missing or invalid API key.
- `403`: The request is authenticated but not allowed: the API key lacks the required scope (`insufficient_scope`), the plan does not include the public API or this feature (`addon_not_active`, `feature_not_available_in_plan`), or the module is not available with a test key (`module_not_available_in_sandbox`).
- `404`: The requested resource does not exist or belongs to another company.
- `422`: Validation failed. The `error.param` field identifies which input is invalid.
- `429`: Rate limit exceeded. Retry after the duration in `Retry-After`.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/factuarea/apis/factuarea-public-api.md) · [All operations](https://skmtc.dev/factuarea/apis/factuarea-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/factuarea/apis/factuarea-public-api/revisions/718e77934422?raw)