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 Parameter	Type	Required
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

Request

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"
        }
      }
    }
  }
}'

Response

On success, the API responds with a 200 OK status code, returning the updated resource object:

{
  "data": {
    "id": "xYZkjABcde",
    "type": "links",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/links/xYZkjABcde"
    },
    "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/xYZkjABcde/relationships/item",
          "related": "https://yourdomain.commercelayer.io/api/links/xYZkjABcde/item"
        }
      },
      "events": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/links/xYZkjABcde/relationships/events",
          "related": "https://yourdomain.commercelayer.io/api/links/xYZkjABcde/events"
        }
      }
    },
    "meta": {
      "mode": "test",
      "organization_id": "xRRkjDFafe",
      "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
    }
  }
}