POST
Validate API Key

Validate API Key

Use this endpoint to validate your API Key

Response fields

Authorizations

Authorization
string
header
required

Use your API key with the 'Bearer ' prefix

Body

application/json
type
string
required
data
object
required

Arbitrary key-value pairs representing custom data. Common attributes include shop_id and shop_name.

Response

For valid API Key.

success
boolean
workspace_id
string
Example:

"cae15020ee"

workspace_name
string
Example:

"Cocoonmail Internal"