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

# Create a link

> Creates a new URL record. The `url` may be a plain link, a link containing `{{field}}` placeholders, or an entire placeholder. Placeholder-only URLs and custom protocol schemes are accepted; other values must be a valid URL after placeholders are resolved.

Create a URL record

**Permission:** requires `manage_links`.

**These are the link records shown on a contact's profile** — defined once org-wide under Settings → Links, then compiled per contact and surfaced as clickable actions on that contact's card. The `url` may carry `{{field}}` placeholders resolved against that contact's data. The route remains `/api/urls`.



## OpenAPI

````yaml /api-reference/specs/short-urls.json post /api/urls
openapi: 3.1.0
info:
  title: ConveYour API — Links
  description: >-
    Create and manage reusable, template-aware tracking links for messages and
    campaigns.
  version: 1.0.0
servers:
  - url: https://{subdomain}.conveyour.com
    description: Your organization's ConveYour instance
    variables:
      subdomain:
        default: acme
        description: >-
          Your organization's slug — the subdomain you sign in on. Replace
          `acme` with yours: if you sign in at `bigco.conveyour.com`, enter
          `bigco`.
security:
  - conveyourToken: []
tags:
  - name: Links
    description: >-
      Create and manage reusable, template-aware tracking links for messages and
      campaigns.
paths:
  /api/urls:
    post:
      tags:
        - Links
      summary: Create a link
      description: >-
        Creates a new URL record. The `url` may be a plain link, a link
        containing `{{field}}` placeholders, or an entire placeholder.
        Placeholder-only URLs and custom protocol schemes are accepted; other
        values must be a valid URL after placeholders are resolved.


        Create a URL record


        **Permission:** requires `manage_links`.


        **These are the link records shown on a contact's profile** — defined
        once org-wide under Settings → Links, then compiled per contact and
        surfaced as clickable actions on that contact's card. The `url` may
        carry `{{field}}` placeholders resolved against that contact's data. The
        route remains `/api/urls`.
      operationId: createAUrlRecord
      parameters:
        - $ref: '#/components/parameters/teams'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - title
                - url
              properties:
                title:
                  description: Human-readable name for the URL record.
                  type: string
                url:
                  description: >-
                    The destination link. May include contact field placeholders
                    such as `{{first name}}`, which are compiled per-contact
                    before delivery.
                  type: string
            example:
              title: Onboarding packet
              url: https://example.com/packet
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/ShortUrlRef'
              example:
                status: ok
                message: Url record created
                data:
                  id: 42
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    teams:
      name: teams[]
      in: query
      description: >-
        Team scope for the request, as one or more team ObjectIds. The brackets
        are required: PHP keeps only the last value for a repeated plain key, so
        `teams=A&teams=B` silently resolves to B alone. On requests with a JSON
        body you may send `teams` (no brackets) in the body instead.


        **Values that are not valid ObjectIds are silently ignored** — a
        mistyped team ID behaves as if no team was sent. See the [teams section
        of the API conventions guide](/guides/api-conventions#team-scoping).
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
      example:
        - 64a1b2c3d4e5f6a7b8c9d0ff
  schemas:
    Envelope:
      type: object
      description: The common response envelope shared by all ConveYour endpoints.
      properties:
        status:
          type: string
          enum:
            - ok
            - failed
          description: '`ok` on success, `failed` on error.'
        message:
          type: string
          description: Human-readable description of the result.
        data:
          description: >-
            The response payload — an object or an array depending on the
            endpoint.
    ShortUrlRef:
      type: object
      description: >-
        Create, update and delete each return only the record id — never the URL
        record.
      properties:
        id:
          type: string
          description: ID of the affected short URL.
      required:
        - id
  responses:
    Forbidden:
      description: >-
        The token is missing or invalid, or the service account behind it lacks
        the permission this endpoint requires.
      content:
        application/json:
          example:
            status: failed
            message: Lacking necessary permission add_contacts
            data:
              permission: add_contacts
  securitySchemes:
    conveyourToken:
      type: apiKey
      in: header
      name: x-conveyour-token
      description: >-
        Your API key token. Contacts endpoints require a **Server-only — Full
        API** key — see [Authentication](/quickstart).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.