PUT /api/v1/brands/{brandId}
Replaces a brand by brandId
Passing an invalid brandId returns a 404 Not Found status code with the error code E0000007.
Not providing agreeToCustomPrivacyPolicy with customPrivacyPolicyUrl returns a 400 Bad Request status code with the error code E0000001.
Servers
- https://{yourOktaDomain}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
brandId |
String | Yes |
The ID of the brand |
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 |
|---|---|---|---|
customPrivacyPolicyUrl |
String | No |
Custom privacy policy URL |
name |
String | Yes |
The name of the Brand |
agreeToCustomPrivacyPolicy |
Boolean | No |
Consent for updating the custom privacy URL. Not required when resetting the URL. |
removePoweredByOkta |
Boolean | No |
Removes "Powered by Okta" from the sign-in page in redirect authentication deployments, and "© [current year] Okta, Inc." from the Okta End-User Dashboard Default value: false |
defaultApp |
Object | No | |
defaultApp.classicApplicationUri |
String | No |
Application URI for classic Orgs |
defaultApp.appLinkName |
String | No |
Name for the app instance |
defaultApp.appInstanceId |
String | No |
ID for the App instance |
emailDomainId |
String | No |
The ID of the email domain |
locale |
String | No |
The language specified as an IETF BCP 47 language tag |
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.