Skip to main content

Update Integration

Overview

Updates an integration's name, permissions, and optional expiration. The API key and secret are immutable and cannot be changed.

Endpoint: PUT /api/v1/integrations/{id}

Authentication: Bearer token (JWT) required.


Request

Headers

HeaderRequiredDescription
AuthorizationYesBearer <your_jwt_token>
Content-TypeYesapplication/json

Path Parameters

ParameterTypeRequiredDescription
idstringYesIntegration UUID

Body

FieldTypeRequiredValidationDescription
namestringYes1–255 charactersDisplay name for the integration
permissionsstring[]NoPermission list (e.g. payments.read, payments.create)
expires_atstringNoISO 8601 datetimeOptional expiration date/time

Example Request

{
"name": "Updated Production API",
"permissions": ["payments.read", "payments.create", "wallets.read"],
"expires_at": "2027-12-31T23:59:59Z"
}

Response

Success — 204 No Content

No response body. The integration was updated successfully.


Error Responses

StatusDescription
400Invalid request (validation error)
401Unauthorized (missing or invalid token)
404Integration not found
500Internal server error

cURL Example

curl -X PUT https://api.example.com/api/v1/integrations/550e8400-e29b-41d4-a716-446655440001 \
-H "Authorization: Bearer YOUR_JWT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Updated Production API",
"permissions": ["payments.read", "payments.create", "wallets.read"]
}'