> ## Documentation Index > Fetch the complete documentation index at: https://docs.apollodeploy.com/llms.txt > Use this file to discover all available pages before exploring further. # Update project > Updates the name or configuration of an existing project. Omitted fields are left unchanged. ### Requirements - **Permission:** `projects:write`. - **Project access:** the path project must match the API key's project. - **HTTP rate limit:** 60 requests per 60 seconds per API key. ## OpenAPI ````yaml /signal/api-reference/openapi.json patch /v1/projects/{projectId} openapi: 3.1.0 info: title: Apollo Signal API version: 1.0.0 description: >- Public REST API for transactional email, contacts, audiences, webhooks, metrics, projects, and sending domains. servers: - url: https://api.signal.apollodeploy.com description: Production security: [] tags: - name: Emails description: Send, inspect, cancel, validate, and stream transactional email activity. - name: Metrics description: Read project, topic, message, and deliverability analytics. - name: Suppressions description: Manage addresses that Apollo Signal must not send to. - name: Segments description: Create dynamic contact groups and inspect their membership. - name: Topics description: Manage subscription topics and topic membership. - name: Contact properties description: Define the custom fields available on project contacts. - name: Contacts description: >- Manage contacts, audience membership, images, activity, and engagement data. - name: Webhooks description: Manage webhook endpoints, deliveries, tests, and replays. - name: API key usage description: Inspect API key metadata and request usage without exposing raw keys. - name: Projects description: Inspect projects and project-scoped email logs. - name: Sending domains description: >- Register, verify, inspect, and remove sending domains and BIMI configuration. paths: /v1/projects/{projectId}: patch: tags: - Projects summary: Update project description: >- Updates the name or configuration of an existing project. Omitted fields are left unchanged. ### Requirements - **Permission:** `projects:write`. - **Project access:** the path project must match the API key's project. - **HTTP rate limit:** 60 requests per 60 seconds per API key. operationId: updateProject parameters: - name: projectId in: path description: The unique identifier of the project to update. required: true deprecated: false explode: false schema: type: string title: String requestBody: description: Fields to update. content: application/json: schema: $ref: >- #/components/schemas/com.apollodeploy.signal.feature.project.api.model.UpdateProjectRequest required: true responses: '200': description: Updated project. headers: {} content: application/json: schema: $ref: >- #/components/schemas/com.apollodeploy.signal.feature.project.api.model.ProjectResponse '400': description: Validation error. headers: {} content: application/problem+json: schema: $ref: >- #/components/schemas/com.apollodeploy.commons.core.error.ApiProblem '401': description: Missing or invalid credentials. headers: {} content: application/problem+json: schema: $ref: >- #/components/schemas/com.apollodeploy.commons.core.error.ApiProblem '403': description: >- The credential lacks the required permission or cannot access this project. headers: {} content: application/problem+json: schema: $ref: >- #/components/schemas/com.apollodeploy.commons.core.error.ApiProblem '404': description: Project not found. headers: {} content: application/problem+json: schema: $ref: >- #/components/schemas/com.apollodeploy.commons.core.error.ApiProblem '429': description: >- The endpoint rate limit was exceeded. Wait for the `Retry-After` interval before retrying. headers: Retry-After: description: Whole seconds to wait before retrying. schema: type: integer minimum: 1 content: application/problem+json: schema: $ref: >- #/components/schemas/com.apollodeploy.commons.core.error.ApiProblem deprecated: false security: - bearerAuth: [] x-codeSamples: - lang: TypeScript label: TypeScript source: >- import { createApolloSignalApiClient } from "@apollo-deploy/signal-sdk"; const signal = createApolloSignalApiClient({ apiKey: "ap_signal_..." }); const result = await signal.projects.updateProject(/* params */); console.log(result); - lang: Python label: Python source: |- from apollo_signal import SignalClient signal = SignalClient(api_key="ap_signal_...") result = signal.projects.updateProject(# params) print(result) - lang: Go label: Go source: >- import signal "github.com/apollo-deploy/signal-sdk-go" client := signal.NewClient("ap_signal_...") result, err := client.Projects.UpdateProject(context.Background() /* params */) if err != nil { log.Fatal(err) } fmt.Println(result) - lang: Java label: Java source: |- import com.apollodeploy.signal.SignalClient; SignalClient signal = new SignalClient("ap_signal_..."); var result = signal.projects().updateProject(/* params */); System.out.println(result); - lang: Kotlin label: Kotlin source: |- import com.apollodeploy.signal.SignalClient val signal = SignalClient("ap_signal_...") val result = signal.projects.updateProject(/* params */) println(result) - lang: Ruby label: Ruby source: |- require "apollo_signal" signal = ApolloSignal::Client.new(api_key: "ap_signal_...") result = signal.projects.updateProject(# params) puts result - lang: PHP label: PHP source: |- use ApolloSignal\SignalClient; $signal = new SignalClient("ap_signal_..."); $result = $signal->projects->updateProject(/* params */); var_dump($result); - lang: Rust label: Rust source: |- use apollo_signal::SignalClient; let signal = SignalClient::new("ap_signal_..."); let result = signal.projects.updateProject(/* params */).await?; println!("{:?}", result); - lang: C# label: .NET source: |- using ApolloSignal; var signal = new SignalClient("ap_signal_..."); var result = await signal.Projects.UpdateProjectAsync(/* params */); Console.WriteLine(result); components: schemas: com.apollodeploy.signal.feature.project.api.model.UpdateProjectRequest: type: object properties: limits: $ref: >- #/components/schemas/com.apollodeploy.signal.feature.project.api.model.ProjectLimitsModel description: Complete replacement for the project's operational limits. name: type: string title: String description: Replacement project name. slug: type: string title: String description: Replacement project slug. trackingSettings: $ref: >- #/components/schemas/com.apollodeploy.signal.feature.project.api.model.ProjectTrackingSettingsModel description: Complete replacement for project-level tracking defaults. title: UpdateProjectRequest description: >- Project identity, limit, and tracking fields to replace; omitted fields remain unchanged. com.apollodeploy.signal.feature.project.api.model.ProjectResponse: type: object properties: createdAt: type: string title: String id: type: string title: String limits: $ref: >- #/components/schemas/com.apollodeploy.signal.feature.project.api.model.ProjectLimitsModel name: type: string title: String region: type: string title: String slug: type: string title: String status: type: string title: String suspensionReason: type: string title: String trackingSettings: $ref: >- #/components/schemas/com.apollodeploy.signal.feature.project.api.model.ProjectTrackingSettingsModel updatedAt: type: string title: String required: - createdAt - id - limits - name - region - slug - status - trackingSettings - updatedAt title: ProjectResponse com.apollodeploy.commons.core.error.ApiProblem: type: object properties: code: type: string title: ErrorCode detail: type: string title: String errors: type: array items: $ref: >- #/components/schemas/com.apollodeploy.commons.core.error.FieldProblem title: List instance: type: string title: ProblemInstance requestId: type: string title: String status: type: integer format: int32 title: Int title: type: string title: String type: type: string title: ProblemType required: - code - status - title - type title: ApiProblem com.apollodeploy.signal.feature.project.api.model.ProjectLimitsModel: type: object properties: dailySends: type: integer format: int32 title: Int description: Maximum non-test sends admitted per day. maxApiKeys: type: integer format: int32 title: Int description: Maximum API keys available to the project. maxDomains: type: integer format: int32 title: Int description: Maximum sending domains registered to the project. maxRecipientsPerMessage: type: integer format: int32 title: Int description: Maximum distinct `to`, `cc`, and `bcc` recipients per message. maxWebhooks: type: integer format: int32 title: Int description: Maximum webhook endpoints available to the project. perSecondSends: type: integer format: int32 title: Int description: Maximum sends admitted per second. required: - dailySends - maxApiKeys - maxDomains - maxRecipientsPerMessage - maxWebhooks - perSecondSends title: ProjectLimitsModel description: >- Operational limits applied to the project. Supply every field when replacing limits. com.apollodeploy.signal.feature.project.api.model.ProjectTrackingSettingsModel: type: object properties: clickTracking: type: boolean title: Boolean description: Enable tracked-link rewriting by default. openTracking: type: boolean title: Boolean description: Enable open-pixel tracking by default. readEngagement: type: boolean title: Boolean description: Enable read-engagement tracking by default. scrollDepth: type: boolean title: Boolean description: Enable scroll-depth tracking by default. Defaults to `false`. default: false unsubscribeTracking: type: boolean title: Boolean description: Enable unsubscribe-link handling by default. required: - openTracking - clickTracking - unsubscribeTracking - readEngagement title: ProjectTrackingSettingsModel description: >- Project defaults for email tracking. Supply every field except `scrollDepth` when replacing settings. com.apollodeploy.commons.core.error.FieldProblem: type: object properties: detail: type: string title: String pointer: type: string title: String required: - detail - pointer title: FieldProblem securitySchemes: bearerAuth: type: http scheme: bearer description: >- Project-bound Apollo Signal API key. Keys begin with `ap_signal_` and must carry the permission shown on the operation. ````