Request restricted catalog access

POST/api/catalogs/{handle}/request-access

Creates or updates a pending access request for the supplied email address.

Path Parameters

handle*string

Stable handle used in routes and lookups.

Example"starter-catalog"

Request Body

application/json

Request payload for Request restricted catalog access.

TypeScript Definitions

Use the request body type in TypeScript.

email*string

Email address requesting access to the catalog.

Match^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Formatemail

note?|

Free-form note.

Response Body

`application/json`

curl -X POST "https://example.com/api/catalogs/starter-catalog/request-access" \  -H "Content-Type: application/json" \  -d '{    "email": "buyer@example.com"  }'

{  "success": true}

{  "_tag": "ApiBadRequestError",  "code": "PRICE_IMPORT_DUPLICATE_SKUS",  "message": "The request payload is invalid.",  "description": "Remove duplicate SKU rows before importing the file.",  "details": null}

{  "_tag": "Unauthorized"}

{  "_tag": "ApiForbiddenError",  "message": "You do not have permission to perform this action."}

{  "_tag": "ApiNotFoundError",  "message": "The requested resource was not found."}

{  "_tag": "ApiConflictError",  "message": "A resource with this handle already exists."}

{  "_tag": "ApiUnprocessableEntityError",  "message": "The order cannot be submitted without items."}

{  "_tag": "ServiceUnavailable"}

{  "_tag": "ApiTimeoutError",  "message": "The upstream operation timed out."}

Request restricted catalog access

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`