Join Links
Amend a join link
Changes a link's configuration in place, keeping its token. At least one field must be supplied. Set `status: disabled` to stop redemptions while keeping the row and its history; to invalidate the URL itself, roll it.
Changes a link's configuration in place, keeping its token. At least one
field must be supplied. Set status: disabled to stop redemptions while
keeping the row and its history; to invalidate the URL itself, roll it.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
linkId*string
Match
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Properties
1 <= propertiesResponse Body
application/json
application/json
curl -X PATCH "https://example.com/join-links/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "token": "string", "label": "string", "ownerResourceType": "project", "ownerResourceId": "7d5ad1db-89f9-42df-868c-86a72347ae1c", "role": "reviewer", "additionalRoles": [ "string" ], "mode": "auto", "allowedEmailDomains": [ "string" ], "status": "active", "expiresAt": "2019-08-24T14:15:22Z", "maxUses": 0, "useCount": 0, "creatorId": "688ebf54-d343-4104-8711-82c2feac534a", "tokenRolledAt": "2019-08-24T14:15:22Z", "rolledByUserId": "4cb4397c-25f6-46d5-b288-c49713e36c73", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}