PATCH /companies/{companyId}/apiCredentials/{apiCredentialId}
Changes the API credential's roles, merchant account access, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request.
To make this request, your API credential must have the following roles:
- Management API—API credentials read and write
Servers
- https://management-test.adyen.com/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
companyId |
String | Yes |
The unique identifier of the company account. |
apiCredentialId |
String | Yes |
Unique identifier of the API credential. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
active |
Boolean | No |
Indicates if the API credential is enabled. |
description |
String | No |
Description of the API credential. |
associatedMerchantAccounts[] |
Array | No |
List of merchant accounts that the API credential has access to. |
roles[] |
Array | No |
List of roles for the API credential. Only roles assigned to 'ws@Company.' can be assigned to other API credentials. |
allowedOrigins[] |
Array | No |
The new list of allowed origins for the API credential. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.