Error
A valid request URL is required to generate request examples{
"referralUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"providerName": "<string>",
"capabilityName": "<string>",
"publisherName": "<string>",
"publisherDomain": "<string>",
"status": "NOT_STARTED",
"expiresAt": "2023-11-07T05:31:56Z"
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Storefront
Preview a publisher invitation
Returns public-safe invitation metadata. The bearer is accepted only in the request body and the endpoint is rate-limited.
POST
/
provider
/
client-referrals
/
preview
Error
A valid request URL is required to generate request examples{
"referralUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"providerName": "<string>",
"capabilityName": "<string>",
"publisherName": "<string>",
"publisherDomain": "<string>",
"status": "NOT_STARTED",
"expiresAt": "2023-11-07T05:31:56Z"
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Pattern:
^[A-Za-z0-9_-]{43}$Response
Preview a publisher invitation
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Available options:
NOT_STARTED, ACCEPTED, EXPIRED, DECLINED, CANCELLED Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$