# Create a link

To [create](https://docs.commercelayer.io/core/creating-resources) a new link, send a `POST` request to the `/api/links` endpoint, passing the resource arguments in the request body.

## Request

**POST** <https://yourdomain.commercelayer.io/api/links>

### Arguments

| Body Parameter                   | Type       | Required                                          |
| -------------------------------- | ---------- | ------------------------------------------------- |
| **type**                         | `string`   | Required                                          |
| attributes.**name**              | `string`   | Required                                          |
| attributes.**client\_id**        | `string`   | Required                                          |
| attributes.**scope**             | `string`   | Required                                          |
| attributes.**starts\_at**        | `datetime` | Optional, default to current time                 |
| attributes.**expires\_at**       | `datetime` | Optional, default to one month since current time |
| attributes.**domain**            | `string`   | Optional, default to "commercelayer.link"         |
| attributes.**item\_type**        | `string`   | Optional                                          |
| attributes.**params**            | `object`   | Optional                                          |
| attributes.**\_disable**         | `boolean`  | Optional                                          |
| attributes.**\_enable**          | `boolean`  | Optional                                          |
| attributes.**reference**         | `string`   | Optional                                          |
| attributes.**reference\_origin** | `string`   | Optional                                          |
| attributes.**metadata**          | `object`   | Optional                                          |
| relationships.**item**           | `object`   | Required                                          |

### Example

{% tabs %}
{% tab title="Request" %}
The following request creates a new link:

```shell
curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/links' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "links",
    "attributes": {
      "name": "FW SALE 2023",
      "client_id": "xxxx-yyyy-zzzz",
      "scope": "market:id:GhvCxsElAQ,market:id:kJhgVcxZDr"
    },
    "relationships": {
      "item": {
        "data": {
          "type": "sku_lists",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'
```

{% endtab %}

{% tab title="Response" %}
On success, the API responds with a `201 Created` status code, returning the created resource object:

```json
{
  "data": {
    "id": "XAyRWNUzyN",
    "type": "links",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/links/XAyRWNUzyN"
    },
    "attributes": {
      "name": "FW SALE 2023",
      "client_id": "xxxx-yyyy-zzzz",
      "scope": "market:id:GhvCxsElAQ,market:id:kJhgVcxZDr",
      "starts_at": "2018-01-01T12:00:00.000Z",
      "expires_at": "2018-01-02T12:00:00.000Z",
      "active": true,
      "status": "pending",
      "domain": "commercelayer.link",
      "url": "https://commercelayer.link/ZXUtd2VzdC0xLzE5ZjBlMGVlLTg4OGMtNDQ1Yi1iYTA0LTg3MTUxY2FjZjFmYQ",
      "item_type": "orders",
      "params": {
        "param1": "ABC",
        "param2": "XYZ"
      },
      "disabled_at": "2018-01-01T12:00:00.000Z",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "item": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/links/XAyRWNUzyN/relationships/item",
          "related": "https://yourdomain.commercelayer.io/api/links/XAyRWNUzyN/item"
        }
      },
      "events": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/links/XAyRWNUzyN/relationships/events",
          "related": "https://yourdomain.commercelayer.io/api/links/XAyRWNUzyN/events"
        }
      },
      "event_stores": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/links/XAyRWNUzyN/relationships/event_stores",
          "related": "https://yourdomain.commercelayer.io/api/links/XAyRWNUzyN/event_stores"
        }
      }
    },
    "meta": {
      "mode": "test",
      "organization_id": "xRRkjDFafe",
      "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
    }
  }
}
```

{% endtab %}
{% endtabs %}