Update a link

How to update an existing link via API

To update an existing link, send a PATCH request to the /api/links/:id endpoint, where id is the ID of the resource that you want to update.

Here below the list of all the possible arguments that you can pass with the request body.

Request

PATCH https://yourdomain.commercelayer.io/api/links/:id

Arguments

Body ParameterTypeRequired

type

string

Required

id

string

Required

attributes.name

string

Optional

attributes.client_id

string

Optional

attributes.scope

string

Optional

attributes.starts_at

datetime

Optional

attributes.expires_at

datetime

Optional

attributes.domain

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

Optional

Example

The following request updates the link identified by the ID "xYZkjABcde":

curl -g -X PATCH \
  'https://yourdomain.commercelayer.io/api/links/xYZkjABcde' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "links",
    "id": "xYZkjABcde",
    "attributes": {
      "params": {
        "param1": "ABC",
        "param2": "XYZ"
      }
    },
    "relationships": {
      "item": {
        "data": {
          "type": "items",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'

Last updated