Upsert a website

Create or update (upsert) a website with specified identifier string.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

Resource identifier string.

Request Body schema: application/json

Website resource.

name
required
string

Name of the website.

url
required
string

Domain address of the website.

servicePhone
required
string

Customer service phone number of the website.

serviceEmail
required
string <email>

Customer service email address of the website.

customFields
object (ResourceCustomFields)
Default: {}

Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.

object (WebsiteSettings)

Website settings.

object

Payment form settings.

css
string

Hosted payment form CSS options.

object

Hosted payment form theme options.

object

Hosted payment form features.

Responses
200

Website updated.

Response Schema: application/json
name
required
string

Name of the website.

url
required
string

Domain address of the website.

servicePhone
required
string

Customer service phone number of the website.

serviceEmail
required
string <email>

Customer service email address of the website.

id
string <= 50 characters

Unique website identifier string. A website is where an organization obtains a customer through a subscription. For more information, see Obtain an organization ID and website ID.

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.

customFields
object (ResourceCustomFields)
Default: {}

Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.

object (WebsiteSettings)

Website settings.

object

Payment form settings.

css
string

Hosted payment form CSS options.

object

Hosted payment form theme options.

object

Hosted payment form features.

organizationId
string <= 50 characters
Deprecated

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

Array of Self (object) or OrganizationLink (object) non-empty

Related resource links.

Array (non-empty)
Any of:
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
201

Website created.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
name
required
string

Name of the website.

url
required
string

Domain address of the website.

servicePhone
required
string

Customer service phone number of the website.

serviceEmail
required
string <email>

Customer service email address of the website.

id
string <= 50 characters

Unique website identifier string. A website is where an organization obtains a customer through a subscription. For more information, see Obtain an organization ID and website ID.

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.

customFields
object (ResourceCustomFields)
Default: {}

Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.

object (WebsiteSettings)

Website settings.

object

Payment form settings.

css
string

Hosted payment form CSS options.

object

Hosted payment form theme options.

object

Hosted payment form features.

organizationId
string <= 50 characters
Deprecated

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

Array of Self (object) or OrganizationLink (object) non-empty

Related resource links.

Array (non-empty)
Any of:
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

422

Invalid data sent.

put/websites/{id}
Request samples
application/json
{
  • "name": "string",
  • "url": "string",
  • "servicePhone": "string",
  • "serviceEmail": "user@example.com",
  • "customFields": {
    },
  • "settings": {
    }
}
Response samples
application/json
{
  • "id": "example.com",
  • "name": "string",
  • "url": "string",
  • "servicePhone": "string",
  • "serviceEmail": "user@example.com",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "customFields": {
    },
  • "settings": {
    },
  • "organizationId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "_links": [
    ]
}