Upsert a website

Request

Creates or updates (upserts) a website with a specified ID.

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required
ID of the resource.
Bodyapplication/jsonrequired
Website resource.
namestringrequired
Name of the website.
urlstringrequired
Domain address of the website.
servicePhonestringrequired
Customer service phone number of the website.
serviceEmailstring, (email)required
Customer service email address of the website.
customFieldsobject(ResourceCustomFields)

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.

Default:{}
Example:
{
  "foo": "bar"
}
settingsobject
Website settings.
logoIdstring or null, <= 50 characters
ID of the linked file object.
Example:"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
curl -i -X PUT \
  'https://www.rebilly.com/_mock/catalog/all/websites/{id}' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "url": "string",
    "servicePhone": "string",
    "serviceEmail": "user@example.com",
    "customFields": {
      "foo": "bar"
    },
    "settings": {
      "paymentForm": {
        "css": "string",
        "theme": {
          "colorPrimary": "#504CCA",
          "pageColorBackground": "#F6F8F9"
        },
        "features": {
          "showCoupons": [
            "string"
          ],
          "fullPageRedirect": false,
          "skipRedirectOnPaymentComplete": false,
          "hideZeroAmountSummaryItems": false
        }
      },
      "amplitude": {
        "tracking": false,
        "apiKey": "35d1795750c585984f7e6b01c0ca6e19"
      },
      "payoutRequest": {
        "automaticReadinessEnabled": false,
        "pendingPeriodHours": 48,
        "automaticReadinessTime": "10:00:00Z"
      }
    },
    "logoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
  }'

Responses

Website updated.
Headers
Rate-Limit-Limitinteger

Maximum number of requests available at one time for this rate limit. For more information, see Rate limits.

Example:500
Rate-Limit-Remaininginteger

Number of requests still available for this rate limit. For more information, see Rate limits.

Example:499
Bodyapplication/json
idstring, <= 50 characters(WebsiteId)read-only
Example:"web_0YV7DE4Z26DQSA1AC92FBJ7SEG"
namestringrequired
Name of the website.
urlstringrequired
Domain address of the website.
servicePhonestringrequired
Customer service phone number of the website.
serviceEmailstring, (email)required
Customer service email address of the website.
createdTimestring, (date-time)(CreatedTime)read-only
Date and time when the resource is created. This value is set automatically when the resource is created.
updatedTimestring, (date-time)(UpdatedTime)read-only
Date and time when the resource is updated. This value is set automatically when the resource is updated.
customFieldsobject(ResourceCustomFields)

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.

Default:{}
Example:
{
  "foo": "bar"
}
settingsobject
Website settings.
logoIdstring or null, <= 50 characters
ID of the linked file object.
Example:"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
logoUrlstring or nullread-only
URL of the website logo.
_linksArray of objectsread-only
Related links.
organizationIdstring, <= 50 characters(OrganizationId)read-onlydeprecated

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

Example:"org_0YVDM8RC7GDADADSBSMW124JA8"
Response
{
  "id": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
  "name": "string",
  "url": "string",
  "servicePhone": "string",
  "serviceEmail": "user@example.com",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "customFields": {
    "foo": "bar"
  },
  "settings": {
    "paymentForm": { … },
    "amplitude": { … },
    "payoutRequest": { … }
  },
  "logoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  "logoUrl": "string",
  "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8",
  "_links": [
    { … }
  ]
}