Return to top
On this page

Tags and domains

All endpoints need authentication.

Tags

MethodURLPermission
GET/apiv2/tagstags:read
POST/apiv2/tagstags:write
GET/apiv2/tags/{id}tags:read
PATCH/apiv2/tags/{id}tags:write
DELETE/apiv2/tags/{id}tags:delete

Create a tag with name (1 to 100 characters) and optional color (#RRGGBB) and icon. A tag name that already exists answers 409 conflict. PATCH takes only the fields that change. Deleting a tag removes it from all links.

bash
curl -X POST https://api.revolink.link/apiv2/tags \
  -H "Authorization: Bearer rvlnk_your_api_key_here" \
  -H "X-Workspace-Id: your_workspace_id" \
  -H "Content-Type: application/json" \
  -d '{ "name": "spring", "color": "#29CC97" }'

Put tags on a link with tagIds when you create or update it.

Domains

MethodURLPermission
GET/apiv2/domainsdomains:read
POST/apiv2/domainsdomains:write
GET/apiv2/domains/{id}domains:read
DELETE/apiv2/domains/{id}domains:delete

POST takes { "domain": "go.example.com" }. The domain starts with status: "pending". Create the DNS record described in the verification field of the response, and the status becomes verified. Only then can links use it. Adding a domain the workspace already has returns it with 200; a domain that belongs to another workspace answers 409.

bash
curl -X POST https://api.revolink.link/apiv2/domains \
  -H "Authorization: Bearer rvlnk_your_api_key_here" \
  -H "X-Workspace-Id: your_workspace_id" \
  -H "Content-Type: application/json" \
  -d '{ "domain": "go.example.com" }'