Skip to content

Create Auth Token Request

The fields accepted when storing a new third-party credential. The credential is created with a token_type of text; no other type can be created over the API.

namestringrequired

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

Example:"Fulfilment API key"
token_valuestringrequired

The credential value. Stored encrypted and never returned by any endpoint.

Example:"sk_live_9f3c2a7b41e8"
request_header_keystringrequired

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", "token_value": "sk_live_9f3c2a7b41e8", "request_header_key": "Authorization", "token_prefix": "Bearer", "description": "Used by the order status connector", "domain": "api.fulfilment.example.com" }