PUT /websites/{id}
Creates or updates (upserts) a website with a specified ID.
Servers
- https://api-sandbox.rebilly.com/organizations/{organizationId}
- https://api.rebilly.com/organizations/{organizationId}
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
logoId |
String | No |
ID of the linked file object. |
url |
String | Yes |
Domain address of the website. |
createdTime |
String | No |
Date and time when the resource is created. This value is set automatically when the resource is created. |
id |
Object | No | |
_links[] |
Array | No |
Related links. |
_links[].href |
String | No |
Link URL. |
_links[].rel |
String | No |
Type of link. Valid values:
|
name |
String | Yes |
Name of the website. |
servicePhone |
String | Yes |
Customer service phone number of the website. |
customFields |
Object | No |
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. |
logoUrl |
String | No |
URL of the website logo. |
updatedTime |
String | No |
Date and time when the resource is updated. This value is set automatically when the resource is updated. |
serviceEmail |
String | Yes |
Customer service email address of the website. |
settings |
Object | No |
Website settings. |
settings.paymentForm |
Object | No |
Payment form settings. |
settings.paymentForm.css |
String | No |
Hosted payment form CSS options. |
settings.paymentForm.theme |
Object | No |
Hosted payment form theme options. |
settings.paymentForm.features |
Object | No |
Hosted payment form features. |
settings.paymentForm.features.skipRedirectOnPaymentComplete |
Boolean | No |
Specifies whether the hosted payment form skips the redirect to the website URL when the payment is completed. Default value: false |
settings.paymentForm.features.fullPageRedirect |
Boolean | No |
Specifies whether the hosted payment form uses a full page redirect, or the default iframe modal, for approval URL redirects. Default value: false |
settings.paymentForm.features.hideZeroAmountSummaryItems |
Boolean | No |
Specifies if the hosted payment form displays 0 amount line items in the summary. Default value: false |
settings.paymentForm.features.showCoupons[] |
Array | No | |
settings.depositForm |
Object | No |
Deposit form settings. |
settings.depositForm.theme |
Object | No |
Theme settings that are used in the deposit form. |
settings.depositForm.theme.colorPrimary |
String | No |
Primary color for the deposit form in hexadecimal format. |
settings.depositForm.theme.colorSecondary |
String | No |
Secondary color for the deposit form in hexadecimal format. |
settings.depositForm.theme.buttonTemplate |
String | No |
Submit button template. |
settings.amplitude |
Object | No |
Amplitude settings. Amplitude is an analytics tool for tracking user behavior. |
settings.amplitude.tracking |
Boolean | No |
Specifies if the hosted pages, such as KYC pages, include Amplitude analytics. Default value: false |
settings.amplitude.apiKey |
String | No |
API key of an Amplitude project. |
organizationId |
Object | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.