Skip to content
Home/
REST API Reference
/
/
Update Auth Token Request

Update Auth Token Request

The fields accepted when updating a stored third-party credential. Every field is optional, and one you omit keeps its current value. The credential value cannot be changed here.

namestring

A name for the credential, so a teammate can identify it later.

Example:"Fulfilment API key"
request_header_keystring

The request header the credential is sent in.

Example:"Authorization"
token_prefixstring

An optional prefix placed before the credential value in the header, for example Bearer.

Example:"Bearer"
descriptionstring

An optional description of what the credential is used for.

Example:"Used by the order status connector"
domainstring

An optional domain to scope the credential to.

Example:"api.fulfilment.example.com"
{
  "name": "Fulfilment API key",
  "request_header_key": "Authorization",
  "token_prefix": "Bearer",
  "description": "Used by the order status connector",
  "domain": "api.fulfilment.example.com"
}