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
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
The following request creates a new link:
Last updated