Activate an API credential

PATCH {{baseUrl}}/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

Request Body

{"active"=>true}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{"id":"YOUR_API_CREDENTIAL","username":"YOUR_USERNAME","clientKey":"YOUR_CLIENT_KEY","allowedIpAddresses":[],"roles":["Management API - Accounts read","Management API - Webhooks read","Management API - API credentials read and write","Management API - Stores read","Management API — Payment methods read","Management API - Stores read and write","Management API - Webhooks read and write","Merchant Recurring role","Data Protection API","Management API - Payout Account Settings Read","Checkout webservice role","Management API - Accounts read and write","Merchant PAL Webservice role"],"active":true,"_links":{"self":{"href":"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL"},"allowedOrigins":{"href":"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins"},"company":{"href":"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"},"generateApiKey":{"href":"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateApiKey"},"generateClientKey":{"href":"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey"}},"associatedMerchantAccounts":[]}