Update an API credential
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
Unique identifier of the API credential.
The unique identifier of the company account.
Indicates if the API credential is enabled.
The new list of allowed origins for the API credential.
List of merchant accounts that the API credential has access to.
Description of the API credential.
List of roles for the API credential. Only roles assigned to 'ws@Company.<CompanyName>' can be assigned to other API credentials.
After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
200 - OK
The request has succeeded.Show more
400 - Bad Request
A problem reading or understanding the request.Show more
401 - Unauthorized
Authentication required.Show more
403 - Forbidden
Insufficient permissions to process the request.Show more
422 - Unprocessable Entity
A request validation error.Show more
500 - Internal Server Error
The server could not process the request.Show more