Providers

List providers

GET/providers

List this brand's custom integration providers.

Authorization

bearerAuth

AuthorizationBearer <token>

Brand Data API key issued for your Custom E-Com integration, sent as Authorization: Bearer <key>.

In: header

Response Body

`application/json`

curl -X GET "https://example.com/providers"

{  "data": [    {      "id": "string",      "key": "bask",      "name": "Bask",      "lookupId": "ezLUu3AC28uEa3qb4tTE4",      "sourceTemplateKey": "string",      "isEnabled": true,      "settings": null    }  ]}

{  "error": "string"}

{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

Create a provider

POST/providers

Create a provider and mint its credentials. The API key and webhook secret are returned EXACTLY ONCE, in this response, and can never be retrieved again.

Authorization

bearerAuth

AuthorizationBearer <token>

Brand Data API key issued for your Custom E-Com integration, sent as Authorization: Bearer <key>.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

key?string

name*string

Response Body

`application/json`

curl -X POST "https://example.com/providers" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "data": {    "id": "string",    "key": "bask",    "name": "Bask",    "lookupId": "ezLUu3AC28uEa3qb4tTE4",    "sourceTemplateKey": "string",    "isEnabled": true,    "settings": null,    "apiKey": "string",    "webhookSecret": "string",    "webhookUrl": "string"  }}

{  "error": "string"}

{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

Get a provider

GET/providers/{providerId}

Fetch one provider owned by this brand. Never returns the API key or webhook secret.

Authorization

bearerAuth

AuthorizationBearer <token>

Brand Data API key issued for your Custom E-Com integration, sent as Authorization: Bearer <key>.

In: header

Path Parameters

providerId*string

Provider id.

Response Body

`application/json`

curl -X GET "https://example.com/providers/string"

{  "data": {    "id": "string",    "key": "bask",    "name": "Bask",    "lookupId": "ezLUu3AC28uEa3qb4tTE4",    "sourceTemplateKey": "string",    "isEnabled": true,    "settings": null  }}

{  "error": "string"}

{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

Update a provider

PATCH/providers/{providerId}

Sparse update of name, isEnabled, and settings. Settings are MERGED into the stored bag, so sending only request_mapping cannot drop the type_matchers routing table.

Authorization

bearerAuth

AuthorizationBearer <token>

Brand Data API key issued for your Custom E-Com integration, sent as Authorization: Bearer <key>.

In: header

Path Parameters

providerId*string

Provider id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

isEnabled?boolean

settings?

Response Body

`application/json`

curl -X PATCH "https://example.com/providers/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "data": {    "id": "string",    "key": "bask",    "name": "Bask",    "lookupId": "ezLUu3AC28uEa3qb4tTE4",    "sourceTemplateKey": "string",    "isEnabled": true,    "settings": null  }}

{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

{  "error": "string"}

{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

{  "error": {    "code": "conversation_not_found",    "message": "string"  }}

200application/json

401application/json

403application/json

404application/json

500application/json

502application/json

201application/json

401application/json

403application/json

404application/json

409application/json

429application/json

500application/json

502application/json

200application/json

401application/json

403application/json

404application/json

500application/json

502application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

502application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`