الانتقال إلى المحتوى الرئيسي
POST
Adds a web domain to a client.

التفويضات

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 to add the domain to.

الجسم

Domain details.

Request body for adding a web domain to a client. The client is taken from the route.

Name
string | null

The domain, e.g. contoso.com. Required, a valid domain name, at most 256 characters, and not already a domain of any of your clients - inbound email from it is matched to this client.

مثال:

"contoso.com"

ExpirationDate
string<date> | null

The registration's expiry, as a calendar date ("yyyy-MM-dd"). Omit it to have it looked up from the domain registry where the registry publishes one.

الاستجابة

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[]