Skip to navigation
BotBye APIProtectionProjects

partial update

View as Markdown

PATCH /api/v1/{account_id}/projects/{project_id}

This endpoint updates a 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.

Request body

Every field is optional; only the ones sent are changed.

  • isProtected (boolean)
  • name (string)
  • domain (string): The site the project protects, as a bare hostname — example.com, not a URL. A value that is not a domain is rejected with protection_domain.not_valid_domain.
  • responseExtraFields (array of string)

Response

200 with an empty JSON object — this endpoint returns no data.

{}

Accepted permissions Project → Project → Update

Token scope Project Action

Authentication

X-Api-Keystring

Personal access token. Create it in your BotBye account under Profile → Personal Access Tokens, tick the scopes the endpoints you call require (see each endpoint’s Token scope), and send the token in the X-Api-Key request header. A token works only for the account it was created in.

Path parameters

account_idstringRequired
project_idstringRequired

Request

This endpoint expects an object.
isProtectedbooleanOptional
namestringOptional
domainstringOptional

Site the project protects, as a bare hostname — example.com.

responseExtraFieldslist of enumsOptional
List of response extra field names to expose.

Response headers

Content-Lengthinteger
ConnectionstringOptional

Response

success

Errors

400
Bad Request Error