Request restricted catalog access

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

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

Request Body

application/json

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,}$

Example"buyer@example.com"

note?string

Optional note attached to the access request.

Lengthlength <= 500

Example"Necesito ver precios para una compra recurrente"

[key: string]?never

Response Body

`application/json`

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

{
  "success": true
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

Empty

{
  "message": "string",
  "_tag": "ApiForbiddenError"
}

{
  "message": "string",
  "_tag": "ApiNotFoundError"
}

{
  "message": "string",
  "_tag": "ApiConflictError"
}

{
  "message": "string",
  "_tag": "ApiUnprocessableEntityError"
}

Empty

{
  "message": "string",
  "_tag": "ApiTimeoutError"
}

Request restricted catalog access

Request Body

Response Body

200application/json

400application/json

401

403application/json

404application/json

409application/json

422application/json

503

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`