跳转到主要内容
PATCH
Updates a web domain of a client. Only the fields sent are changed.

授权

X-API-Key
string
header
必填

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

路径参数

clientId
integer<int64>
必填

Client the domain belongs to.

domainId
integer<int64>
必填

Domain to update, its Id in the client's Domains.

请求体

Domain fields to change.

Request body for changing a client's web domain. Send only what should change; an omitted field keeps its value.

Name
string | null

The domain, e.g. contoso.com: a valid domain name, at most 256 characters, not already a domain of any of your clients. Null leaves it unchanged.

示例:

"contoso.com"

ExpirationDate
string<date> | null

The registration's expiry, as a calendar date ("yyyy-MM-dd"); a date sent is kept as set by hand. Send null to go back to the date looked up from the domain registry.

响应

OK

StatusCode
enum<integer>
可用选项:
100,
101,
102,
103,
200,
201,
202,
203,
204,
205,
206,
207,
208,
226,
300,
301,
302,
303,
304,
305,
306,
307,
308,
400,
401,
402,
403,
404,
405,
406,
407,
408,
409,
410,
411,
412,
413,
414,
415,
416,
417,
421,
422,
423,
424,
426,
428,
429,
431,
451,
500,
501,
502,
503,
504,
505,
506,
507,
508,
510,
511
IsSuccess
boolean
Data
object

A web domain associated with a client. Timestamps are UTC.

DataContext
object | null
示例:

null

Notifications
object[]