SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

Include or exclude a file from the pull request

PATCHhttps://app.softsolz.uk/api/v1/services/seo/code/fixes/{fix_set_id}/files/{file_id}

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

fix_set_idstringrequired
file_idstringrequired

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

includedbooleanrequired

false leaves the file out of the push.

Response

Response Body

idstringFix file id. Use it as file_id.
fix_set_idstringParent fix set.
file_pathstringRepository path.
change_kindstringupdate for an existing file, create for a new one.
titlestringShort description of the change.
reasonstring | nullWhy the change helps.
page_pathstring | nullURL path the file renders.
check_idsarray of stringsAudit checks the change addresses.
includedbooleanWhether the file will be part of the pull request.
after_bytesinteger | nullSize of the new content.
before_contentstring | nullOriginal content, only when include_content=true.
after_contentstring | nullNew content, only when include_content=true.

Request

curl --request PATCH \
--url https://app.softsolz.uk/api/v1/services/seo/code/fixes/{fix_set_id}/files/{file_id} \
--header 'Authorization: Bearer sk_live_your_key' \
--header 'Content-Type: application/json' \
--data '{
"included": false
}'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
"data": {
"id": "3f2b9c44-8f4e-4d0a-9c1b-2a7d6e5f1a23",
"fix_set_id": "3f2b9c44-8f4e-4d0a-9c1b-2a7d6e5f1a23",
"file_path": "src/pages/index.astro",
"change_kind": "update",
"title": "Add a meta description",
"reason": null,
"page_path": "/",
"check_ids": [
"description_present"
],
"included": true,
"after_bytes": 4210,
"before_content": null,
"after_content": null
}
}