Create a link

How to create a link via API

To create 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 ParameterTypeRequired

type

string

Required

attributes.name

string

Required

attributes.client_id

string

Required

attributes.scope

string

Required

attributes.starts_at

datetime

Required

attributes.expires_at

datetime

Required

attributes.domain

string

Optional, default to "c11r.link"

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

The following request creates a new link:

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:GhvCxsElAQ,market:kJhgVcxZDr",
      "starts_at": "2018-01-01T12:00:00.000Z",
      "expires_at": "2018-01-02T12:00:00.000Z"
    },
    "relationships": {
      "item": {
        "data": {
          "type": "sku_lists",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'

Last updated