Update an API credential

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

Endpoint destination URL

Click to copy

Path parameters

apiCredentialId string Required

Unique identifier of the API credential.

companyId string Required

The unique identifier of the company account.

Request parameters

active boolean

Indicates if the API credential is enabled.

allowedOrigins array [string]

The new list of allowed origins for the API credential.

associatedMerchantAccounts array [string]

List of merchant accounts that the API credential has access to.

description string

Description of the API credential.

roles array [string]

List of roles of the API credential.

Response parameters

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.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy