> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://api-docs.botbye.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api-docs.botbye.com/_mcp/server.

# partial update

PATCH {base_url}/api/v1/{account_id}/projects/{project_id}
Content-Type: application/json

### GET /api/v1/{account_id}/projects/{project_id}

This endpoint retrieves project details for a specific project within an account.

#### Request

- `base_url` (string): The base URL of the API.
- `account_id` (string): The unique identifier of the account.
- `project_id` (string): The unique identifier of the project.
    

#### Response

The response for this request is a JSON object with the following schema:

``` json
{
  "id": "",
  "customerId": "",
  "name": "",
  "url": "",
  "siteKey": "",
  "serverKey": "",
  "isProtected": true,
  "rules": {
    "order": [],
    "rules": []
  },
  "rateLimits": {
    "order": [],
    "rateLimits": []
  },
  "phishingInfo": {
    "originalUrl": "",
    "action": "",
    "allowedUrls": []
  },
  "responseExtraFields": [],
  "updatedAt": "",
  "createdAt": ""
}

 ```

- `id` (string): The unique identifier of the project.
- `customerId` (string): The unique identifier of the customer associated with the project.
- `name` (string): The name of the project.
- `url` (string): The URL of the project.
- `siteKey` (string): The site key of the project.
- `serverKey` (string): The server key of the project.
- `isProtected` (boolean): Indicates whether the project is protected.
- `rules` (object): An object containing order and rules arrays.
- `rateLimits` (object): An object containing order and rateLimits arrays.
- `phishingInfo` (object): An object containing originalUrl, action, and allowedUrls arrays.
- `responseExtraFields` (array): An array of extra fields in the response.
- `updatedAt` (string): The timestamp when the project was last updated.
- `createdAt` (string): The timestamp when the project was created.

Reference: https://api-docs.botbye.com/bot-bye-api/protection/projects/partial-update

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: collection
  version: 1.0.0
paths:
  /api/v1/{account_id}/projects/{project_id}:
    patch:
      operationId: partial-update
      summary: partial update
      description: >-
        ### GET /api/v1/{account_id}/projects/{project_id}


        This endpoint retrieves project details for a specific project within an
        account.


        #### Request


        - `base_url` (string): The base URL of the API.

        - `account_id` (string): The unique identifier of the account.

        - `project_id` (string): The unique identifier of the project.
            

        #### Response


        The response for this request is a JSON object with the following
        schema:


        ``` json

        {
          "id": "",
          "customerId": "",
          "name": "",
          "url": "",
          "siteKey": "",
          "serverKey": "",
          "isProtected": true,
          "rules": {
            "order": [],
            "rules": []
          },
          "rateLimits": {
            "order": [],
            "rateLimits": []
          },
          "phishingInfo": {
            "originalUrl": "",
            "action": "",
            "allowedUrls": []
          },
          "responseExtraFields": [],
          "updatedAt": "",
          "createdAt": ""
        }

         ```

        - `id` (string): The unique identifier of the project.

        - `customerId` (string): The unique identifier of the customer
        associated with the project.

        - `name` (string): The name of the project.

        - `url` (string): The URL of the project.

        - `siteKey` (string): The site key of the project.

        - `serverKey` (string): The server key of the project.

        - `isProtected` (boolean): Indicates whether the project is protected.

        - `rules` (object): An object containing order and rules arrays.

        - `rateLimits` (object): An object containing order and rateLimits
        arrays.

        - `phishingInfo` (object): An object containing originalUrl, action, and
        allowedUrls arrays.

        - `responseExtraFields` (array): An array of extra fields in the
        response.

        - `updatedAt` (string): The timestamp when the project was last updated.

        - `createdAt` (string): The timestamp when the project was created.
      tags:
        - subpackage_projects
      parameters:
        - name: account_id
          in: path
          required: true
          schema:
            type: string
        - name: project_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Projects_partialUpdate_Response_200'
        '400':
          description: fail
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/ApiV1AccountIdProjectsProjectIdPatchResponsesContentApplicationJsonSchemaItems
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                isProtected:
                  type: boolean
                name:
                  type: string
                url:
                  type: string
                  format: uri
                responseExtraFields:
                  type: array
                  items:
                    type: string
                  description: List of response extra field names to expose.
servers:
  - url: '{base_url}'
    description: '{base_url}'
components:
  schemas:
    Projects_partialUpdate_Response_200:
      type: object
      properties: {}
      title: Projects_partialUpdate_Response_200
    ApiV1AccountIdProjectsProjectIdPatchResponsesContentApplicationJsonSchemaItems:
      type: object
      properties:
        message:
          type: string
        code:
          type: string
        type:
          type: string
        context:
          description: Any type
      required:
        - message
        - code
        - type
      title: >-
        ApiV1AccountIdProjectsProjectIdPatchResponsesContentApplicationJsonSchemaItems

```

## Examples



**Request**

```json
{
  "isProtected": true,
  "name": "BotBye Analytics Dashboard",
  "url": "https://dashboard.botbye.com",
  "responseExtraFields": [
    "customField1",
    "customField2"
  ]
}
```

**Response**

```json
{
  "id": "proj_8f3b2c1d9a7e4f6b",
  "customerId": "cust_4a7d9e2f1b3c5d6e",
  "name": "BotBye Analytics Dashboard",
  "url": "https://dashboard.botbye.com",
  "siteKey": "sitekey_1234567890abcdef",
  "serverKey": "serverkey_abcdef1234567890",
  "isProtected": true,
  "rules": {
    "order": [
      "rule1",
      "rule2"
    ],
    "rules": [
      {
        "id": "rule1",
        "type": "block",
        "criteria": "ip == 192.168.1.1"
      },
      {
        "id": "rule2",
        "type": "allow",
        "criteria": "userAgent contains 'Mozilla'"
      }
    ]
  },
  "rateLimits": {
    "order": [
      "limit1"
    ],
    "rateLimits": [
      {
        "id": "limit1",
        "maxRequests": 1000,
        "period": "1h"
      }
    ]
  },
  "phishingInfo": {
    "originalUrl": "https://phishing.example.com",
    "action": "block",
    "allowedUrls": [
      "https://safe.example.com",
      "https://trusted.example.com"
    ]
  },
  "responseExtraFields": [
    "customField1",
    "customField2"
  ],
  "updatedAt": "2024-06-10T12:45:00Z",
  "createdAt": "2023-11-05T08:30:00Z"
}
```

**SDK Code**

```python Projects_partialUpdate_example
import requests

url = "https://{base_url}/api/v1/account_id/projects/project_id"

payload = {
    "isProtected": True,
    "name": "BotBye Analytics Dashboard",
    "url": "https://dashboard.botbye.com",
    "responseExtraFields": ["customField1", "customField2"]
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript Projects_partialUpdate_example
const url = 'https://{base_url}/api/v1/account_id/projects/project_id';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: '{"isProtected":true,"name":"BotBye Analytics Dashboard","url":"https://dashboard.botbye.com","responseExtraFields":["customField1","customField2"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Projects_partialUpdate_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{base_url}/api/v1/account_id/projects/project_id"

	payload := strings.NewReader("{\n  \"isProtected\": true,\n  \"name\": \"BotBye Analytics Dashboard\",\n  \"url\": \"https://dashboard.botbye.com\",\n  \"responseExtraFields\": [\n    \"customField1\",\n    \"customField2\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Projects_partialUpdate_example
require 'uri'
require 'net/http'

url = URI("https://{base_url}/api/v1/account_id/projects/project_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"isProtected\": true,\n  \"name\": \"BotBye Analytics Dashboard\",\n  \"url\": \"https://dashboard.botbye.com\",\n  \"responseExtraFields\": [\n    \"customField1\",\n    \"customField2\"\n  ]\n}"

response = http.request(request)
puts response.read_body
```

```java Projects_partialUpdate_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://{base_url}/api/v1/account_id/projects/project_id")
  .header("Content-Type", "application/json")
  .body("{\n  \"isProtected\": true,\n  \"name\": \"BotBye Analytics Dashboard\",\n  \"url\": \"https://dashboard.botbye.com\",\n  \"responseExtraFields\": [\n    \"customField1\",\n    \"customField2\"\n  ]\n}")
  .asString();
```

```php Projects_partialUpdate_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://{base_url}/api/v1/account_id/projects/project_id', [
  'body' => '{
  "isProtected": true,
  "name": "BotBye Analytics Dashboard",
  "url": "https://dashboard.botbye.com",
  "responseExtraFields": [
    "customField1",
    "customField2"
  ]
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Projects_partialUpdate_example
using RestSharp;

var client = new RestClient("https://{base_url}/api/v1/account_id/projects/project_id");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"isProtected\": true,\n  \"name\": \"BotBye Analytics Dashboard\",\n  \"url\": \"https://dashboard.botbye.com\",\n  \"responseExtraFields\": [\n    \"customField1\",\n    \"customField2\"\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Projects_partialUpdate_example
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [
  "isProtected": true,
  "name": "BotBye Analytics Dashboard",
  "url": "https://dashboard.botbye.com",
  "responseExtraFields": ["customField1", "customField2"]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://{base_url}/api/v1/account_id/projects/project_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```