logo

Create a custom domain

Create a custom domain.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json
domain
required
string <= 255 characters

Fully qualified domain name.

Responses
201

Custom domain created.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
domain
required
string <= 255 characters

Fully qualified domain name.

id
string <= 255 characters

ID of the custom domain.

isVerified
boolean

True if the domain is verified by Rebilly.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

post/custom-domains
Request samples
application/json
{
  • "domain": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "domain": "string",
  • "isVerified": true,
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}
➔ Next to Retrieve a custom domain