Update an API credential

How to update an existing API credential via API

To update an existing API credential, send a PATCH request to the /api/api_credentials/:id endpoint, where id is the ID of the resource that you want to update.

Here below the list of all the possible arguments that you can pass with the request body.

Request

PATCH https://provisioning.commercelayer.io/api/api_credentials/:id

Arguments

Body ParameterTypeRequired

type

string

Required

id

string

Required

attributes.name

string

Optional

attributes.redirect_uri

string

Optional

attributes.expires_in

integer

Optional

attributes.reference

string

Optional

attributes.reference_origin

string

Optional

attributes.metadata

object

Optional

relationships.role

object

Optional

Example

The following request updates the API credential identified by the ID "xYZkjABcde":

curl -g -X PATCH \
  'https://provisioning.commercelayer.io/api/api_credentials/xYZkjABcde' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer {{your_access_token}}' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "api_credentials",
    "id": "xYZkjABcde",
    "attributes": {
      "reference": "ANY-EXTERNAL-REFEFERNCE"
    },
    "relationships": {
      "role": {
        "data": {
          "type": "roles",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'

Last updated