StackMoreLayersДокументация
APIReference

Изменить или отозвать ссылку-приглашение

PATCH
/competitions/{competition_id}/invite-links/{public_id}/

A link is never edited, only closed: status: revoked. Everyone who joined through it keeps their access, unless revoke_mode: withdraw also takes back what the link gave.

Personal tokens only for now: access is managed by a person, so a competition automation token is refused (401 token_type_not_allowed).

АвторизацияBearer <token>

StackMoreLayers API token. Send as Authorization: Bearer sml_pat_live_<prefix>.<secret>.

In: header

Параметры пути

competition_id*integer

Numeric competition identifier.

Range1 <= value
public_id*string
Lengthlength <= 64

Тело запроса

application/json

Типы TypeScript

Use the request body type in TypeScript.

Ответ

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/competitions/1/invite-links/string/" \  -H "Content-Type: application/json" \  -d '{    "status": "revoked"  }'
{  "id": 0,  "public_id": "string",  "name": "string",  "cohort_name": "string",  "cohort_group_ref": "string",  "status": "active",  "role": "viewer",  "kind": "link",  "audience": {    "mode": "anyone",    "domains": [      "string"    ],    "emails": [      "string"    ]  },  "max_redemptions": 1,  "redemptions_count": 0,  "is_full": true,  "starts_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "revoked_at": "2019-08-24T14:15:22Z",  "last_redeemed_at": "2019-08-24T14:15:22Z",  "signin_route": "string",  "converted_participants": 0}