PATCH

Update a program

ENDPOINT/v1/programs/{program_id}

Applies a partial update to a program's name, status, or settings. Omitted fields are left unchanged. Set status to PAUSED to stop new cards and decline new authorizations under the program.

Authentication & Headers

Header	Type	Requirement	Description
Authorization	string	REQUIRED	API key passed as an HTTP Bearer token: `Bearer rk_live_...`
X-Program-ID	UUID	PROGRAM-SCOPED	Program boundary UUID that scopes the issuing card, wallet, or transfer.
Content-Type	string	REQUIRED	Must be `application/json`.
Idempotency-Key	string	OPTIONAL	Unique UUID to prevent duplicate execution of financial creations or mutations.

Path Parameters

Parameter	Type	Requirement	Description
program_id	string	REQUIRED	Unique identifier of the program.

Request Body Schema

application/json

jurisdictionsarray

optional

Replaces the regulatory regions the program operates in.

namestring

optional

Display name of the program.

statusstring

optional

Lifecycle of a program. `ACTIVE` programs accept new cards and authorizations. `PAUSED` programs reject new cards and decline new authorizations; existing cards and balances remain visible.

Enum values:ACTIVEPAUSED

settingsobject

optional

Partial update for program settings. Omitted keys are left unchanged.

Properties of settings

timezonestring

IANA time zone used for billing-cycle cutoffs and reporting windows.

default_currencystring

ISO 4217 currency used as the default for products and cards created under this program.

customer_service_emailstring

Address printed on statements and shown to cardholders for support.

Response Codes & Schemas

200The program after the update.

application/json

{
  "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "object": "program",
  "name": "Consumer Credit",
  "status": "PAUSED",
  "settings": {
    "timezone": "America/New_York",
    "default_currency": "USD",
    "customer_service_email": "support@rookpayments.com"
  },
  "network_program_ids": [
    "550e8400-e29b-41d4-a716-446655440000",
    "4c9a1e30-77b2-4f16-9d21-0b8c5a3e7f11"
  ],
  "jurisdictions": [
    "US"
  ],
  "program_wallet_id": "0a7e3d52-9c1b-4e86-b2f4-6d8a1c3e5f70",
  "created_at": "2026-08-01T12:00:00Z",
  "updated_at": "2026-08-27T16:20:00Z"
}

400Bad Request: malformed JSON, failed schema validation, or conflicting parameters.

application/json

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "invalid order by: foo. Valid options are: [created_at updated_at]",
    "param": "order_by",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/invalid_request"
  }
}

401Unauthorized: missing, malformed, or unknown API key.

application/json

{
  "error": {
    "type": "authentication_error",
    "code": "authentication_error",
    "message": "A valid API key is required.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/authentication_error"
  }
}

403Forbidden: the API key is denied by RBAC, or it cannot access this program. A resource that exists on another program or organization returns `404 not_found`, not `403`.

application/json

{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The API key cannot access this program.",
    "param": "X-Program-ID",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/permission_denied"
  }
}

404Not Found: unknown id, or the resource is not visible to this API key.

application/json

{
  "error": {
    "type": "not_found_error",
    "code": "not_found",
    "message": "No card found for the given id.",
    "param": "card_id",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/not_found"
  }
}

409Conflict: incompatible state, or Idempotency-Key reused with a different body.

application/json

{
  "error": {
    "type": "conflict_error",
    "code": "conflict",
    "message": "The card cannot be reissued from its current state.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/conflict"
  }
}

429Too Many Requests: the API key exceeded its rate limit.

application/json

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limited",
    "message": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/rate_limited"
  }
}

500Internal Server Error: unexpected failure. Retry with the same Idempotency-Key.

application/json

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred. Retry with the same Idempotency-Key.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/internal_error"
  }
}