PUT

Update domain group

https://linkshift.app/api/v1/domain-groups/{id}

Updates mutable domain-group fields such as name and robots policy options.

Operation ID:updateDomainGroupTags: Domain Groups

Back to API reference

Security

ApiKeyAuth: apiKey | header:X-API-Key | API key generated in LinkShift dashboard (`Organization -> Manage API keys`).

Parameters

Path parameters

idrequired

Type: stringDescription: Resource identifier.

Request body schema

requestBodyobjectrequired

Payload for updating a domain group.

customRobotsContentstring | nullnullable

Required when robotsPolicy is CUSTOM.

maxLength: 4096

namestringrequired

Domain-group name.

minLength: 1

robotsPolicystring

Controls robots.txt behavior for all domains in a domain group. CUSTOM requires customRobotsContent.

default: NONEenum: NONE, ALLOW_ALL, DISALLOW_ALL, DISALLOW_BAD_BOTS, CUSTOM

Response schema

Updated domain group

Content type: application/json

response 200objectrequired

Domain-group entity used to scope domains, rules, tests, and link maps.

createdAtstringrequired

Creation timestamp (UTC).

format: date-time

customRobotsContentstring | nullnullable

Used only when robotsPolicy is CUSTOM.

maxLength: 4096

deletedAtstring | nullnullable

Soft-delete timestamp in UTC when deleted.

format: date-time

idstringrequired

Domain-group ID.

namestringrequired

Human-readable domain-group name.

organizationIdstringrequired

Owning organization ID.

robotsPolicystringrequired

Controls robots.txt behavior for all domains in a domain group. CUSTOM requires customRobotsContent.

default: NONEenum: NONE, ALLOW_ALL, DISALLOW_ALL, DISALLOW_BAD_BOTS, CUSTOM

updatedAtstringrequired

Last update timestamp (UTC).

format: date-time