RelayAPI
Short Links

Update short link configuration

Create or update the organization's short link configuration. Set mode, provider, and credentials.

PUT
/v1/short-links/config

Authorization

Bearer
AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_). Invite redemption also accepts a server-derived rlay_session_ bearer for a current user session.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/short-links/config" \  -H "Content-Type: application/json" \  -d '{    "mode": "always"  }'
{  "created_at": "2019-08-24T14:15:22Z",  "domain": "string",  "has_api_key": true,  "id": "string",  "mode": "always",  "provider": "relayapi",  "updated_at": "2019-08-24T14:15:22Z"}

Found something wrong? Help us improve this page.

Report an issueEdit this page on GitHub

Test short link configuration POST

Test the configured provider with a read-only credential probe. No remote link is created.

Signatures

Next Page