Update project

Updates project attributes.

PATCH/v1/projects/{projectId}

Requires an API key with the projects.manage action.

Path parameters

  • projectId · string · required · min length 1 · example prj_example

    Project identifier.

Request body

application/json · required

Update project request body.

  • name · string · min length 1 · max length 100 · example Payments Updated

    Updated project name.

  • description · string | null · max length 500 · example Updated project description.

    Updated description. Use null to clear.

  • settings · object | null

    Updated project settings. Use null to clear.

    • webhookUrl · string · format uri

    • metadata · object

      • * · string

Responses

  • 200 Project updated

    • data · object · required

      Project response payload.

      • project · object · required

        Project details.

        • id · string · required · min length 1 · example prj_example

          Project identifier.

        • organizationId · string · required · min length 1 · example org_example

          Organization identifier.

        • name · string · required · example Payments

          Project name.

        • slug · string · required · example payments

          URL-friendly slug.

        • description · string | null · required · example Payments workflow

          Optional project description.

        • environment · string · required · one of sandbox, beta, production · example sandbox

          Project environment.

        • settings · object | null · required

          Project settings, or null when none have been set.

          • webhookUrl · string · format uri · example https://example.com/webhook

            Webhook URL for event notifications.

          • metadata · object

            Arbitrary metadata key/value pairs.

            • * · string

        • status · string · required · one of active, archived · example active

          Project status.

        • createdBy · string · required · min length 1 · example usr_example

          Identifier of the creator.

        • createdAt · string · required · format date-time · example 2025-01-01T00:00:00.000Z

          Creation timestamp.

        • updatedAt · string · required · format date-time · example 2025-01-02T00:00:00.000Z

          Last update timestamp.

    • meta · object · required

      Response metadata.

      • requestId · string · required · min length 1 · example req_example

        Request identifier for tracing.

      • timestamp · string · required · format date-time · example 2025-01-01T00:00:00.000Z

        ISO 8601 timestamp.

  • 400 Bad Request

    • error · object · required

      Standard error payload.

      • code · string · required

        Machine-readable error code.

      • message · string · required

        Human-readable error message.

      • details · object

        Optional error details for debugging.

        • * · any

    • meta · object

      • requestId · string · min length 1 · example req_example

        Request identifier for tracing.

  • 401 Unauthorized

    Same fields as 400.

  • 403 Forbidden. Requires the projects.manage action: an API key must hold it (a module's manage or execute also covers its read), and a signed-in member's organization role must include it. Without it the error is INSUFFICIENT_PERMISSIONS and error.details.action names the action. Any other 403 names its own reason.

    Same fields as 400.

  • 404 Not Found

    Same fields as 400.

  • 500 Internal Server Error

    Same fields as 400.

Example request

curl -X PATCH 'https://api.solana.com/v1/projects/prj_example' \
  -H "Authorization: Bearer $SDP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Payments Updated",
    "description": "Updated project description.",
    "settings": {
      "webhookUrl": "https://example.com/webhook"
    }
  }'

Example responses

{
  "data": {
    "project": {
      "id": "prj_example",
      "organizationId": "org_example",
      "name": "Payments",
      "slug": "payments",
      "description": "Payments workflow",
      "environment": "sandbox",
      "settings": {
        "webhookUrl": "https://example.com/webhook",
        "metadata": {
          "region": "us"
        }
      },
      "status": "active",
      "createdBy": "usr_example",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-02T00:00:00.000Z"
    }
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}

Error responses use the standard error shape.

Is this page helpful?