[lightMode]

Update SEO Settings

PUT/seo

[updatedIn] 2 months ago

This endpoint allows you to update your Store's SEO Settings, such as Title, Keywords, and Description.

`metadata.read_write`- Metadata Read & Write

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

to [header]，whose value is to concatenate the Token after the Bearer.

[api.label.example]

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

title

string

optional

SEO Title. 🌐 Support multi-language

Example:

SEO Title

description

string

optional

SEO Description. 🌐 Support multi-language

Example:

SEO Description

keywords

string

optional

SEO Keywords. 🌐 Support multi-language

Example:

SEO Keywords

url

string

optional

Sitemap URL.

Example:

https://salla.sa/your-store/sitemap.xml

friendly_urls_status

boolean

optional

Whether or not the SEO enabled for friendly URLS .

Default:

true

refersh_sitemap

boolean

optional

Whether or not to refresh the sitemap.

{
  "title": "SEO Title",
  "description": "SEO Description",
  "keywords": "SEO Keywords",
  "friendly_urls_status": true
}

Request samples

[api.label.responses]

Success(200)

Error Validation(422)

HTTP Code: 200

Content Type : JSONapplication/json

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

object

optional

title

string

optional

SEO Title. 🌐 Support multi-language

Example:

SEO 101

keywords

string

optional

SEO Keywords. 🌐 Support multi-language

Example:

SEO Marketing

description

string

optional

SEO Description. 🌐 Support multi-language

Example:

That is SEO Marketing

url

string

optional

Sitemap URL

Example:

https://salla.sa/testweb/sitemap.xml

friendly_urls_status

boolean

optional

Whether or not the SEO enabled for friendly URLS

Default:

true

refersh_sitemap

string

optional

Sitemap Refresh URL

Example:

https://salla.sa/testweb/sitemap/generate/1305146709

{
  "status": 200,
  "success": true,
  "data": {
    "description": "SEO Description",
    "keywords": "SEO Keywords",
    "title": "SEO Title",
    "url": "https://salla.sa/your-store/sitemap.xml",
    "friendly_urls_status": true,
    "refersh_sitemap": "https://salla.sa/your-store/sitemap/generate/1305146709"
  }
}

[updatedIn] 2 months ago