Tasks

Create a task external link

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.

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

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

taskstring uuid required

Public identifier (UUID v7) of the task.

Headers

Idempotency-Keystring

Example:01928f10-7c0e-7c4a-9b7d-2f8a6e3c1d4b

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide.

Factuarea-Versionstring date

Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Request body

urlstring uri required

http or https URL of the link, at most 2,048 characters and without credentials.

titlestring nullable

Optional title of the link, at most 200 characters.

Response

Example response

{
  "data": {
    "id": "0193a4f2-cd97-7b88-8c29-1e3f5a7b9d01",
    "object": "task_external_link",
    "task_id": "0193a4f2-8f53-7d44-8e85-7a9b1c3d5f12",
    "url": "https://docs.example.com/pasarela/integracion-checkout",
    "title": "Guía de integración de la pasarela",
    "resource_type": "url",
    "created_at": "2026-09-15T10:06:40+02:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.