Create collection access request

POST

https://api.sureshake.com/v2/collections/{collectionId}/access-requests

Path parameters

collectionId
string
required
format: uuid

Request body JSON

requesterEntityId
optional
string
format: uuid
requestNote
optional
string
maxLength: 2000

Returns

201

Default Response

JSON

data
object
required
- id
  string
  required
  format: uuid
- collectionId
  string
  required
  format: uuid
- requesterUserId
  string
  required
- requesterEntityId
  string
  or null
  required
  format: uuid
- status
  pending
  or
  approved
  or
  rejected
  or
  cancelled
  required
- tokenNetwork
  base-mainnet
  required
- tokenGrantStatus
  not_requested
  or
  pending
  or
  granted
  or
  revoked
  or
  failed
  required
- tokenGrantJobId
  string
  or null
  required
- tokenGrantAttempts
  integer
  required
  minimum: 0
- tokenGrantLastError
  string
  or null
  required
- tokenGrantLastAttemptAt
  string
  or null
  required
  format: date-time
- tokenGrantCompletedAt
  string
  or null
  required
  format: date-time
- requestNote
  string
  or null
  required
- reviewNotes
  string
  or null
  required
- reviewedBy
  string
  or null
  required
- reviewedAt
  string
  or null
  required
  format: date-time
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

503

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

Create collection access request

curl --request POST \
  --url 'https://api.sureshake.com/v2/collections/<collectionId>/access-requests' \
  --header 'Content-Type: application/json' \
  --data '
{
  "requesterEntityId": "af12adbd-3666-4602-844a-00328f5c0509",
  "requestNote": "string"
}
'

const url = 'https://api.sureshake.com/v2/collections/<collectionId>/access-requests';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    requesterEntityId: 'af12adbd-3666-4602-844a-00328f5c0509',
    requestNote: 'string'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.sureshake.com/v2/collections/<collectionId>/access-requests"

payload = {
    "requesterEntityId": "af12adbd-3666-4602-844a-00328f5c0509",
    "requestNote": "string"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "collectionId": "0ffe69e2-b7af-4b1e-835c-867376165f50",
    "requesterUserId": "string",
    "requesterEntityId": "af12adbd-3666-4602-844a-00328f5c0509",
    "status": "pending",
    "tokenNetwork": "base-mainnet",
    "tokenGrantStatus": "not_requested",
    "tokenGrantJobId": "string",
    "tokenGrantAttempts": 0,
    "tokenGrantLastError": "string",
    "tokenGrantLastAttemptAt": "2019-08-24T14:15:22Z",
    "tokenGrantCompletedAt": "2019-08-24T14:15:22Z",
    "requestNote": "string",
    "reviewNotes": "string",
    "reviewedBy": "string",
    "reviewedAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}