(branding())
- create - Create brand properties for the specified account.
To access this endpoint using an access token
you'll need to specify the /accounts/{accountID}/branding.write scope.
- upsert - Create or replace brand properties for the specified account.
To access this endpoint using an access token
you'll need to specify the /accounts/{accountID}/branding.write scope.
- get - Get brand properties for the specified account.
To access this endpoint using an access token
you'll need to specify the /accounts/{accountID}/branding.read scope.
- update - Updates the brand properties for the specified account.
To access this endpoint using an access token
you'll need to specify the /accounts/{accountID}/branding.write scope.
Create brand properties for the specified account.
To access this endpoint using an access token
you'll need to specify the /accounts/{accountID}/branding.write scope.
package hello.world;
import io.moov.sdk.Moov;
import io.moov.sdk.models.components.*;
import io.moov.sdk.models.errors.BrandValidationError;
import io.moov.sdk.models.errors.GenericError;
import io.moov.sdk.models.operations.CreateBrandResponse;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws GenericError, BrandValidationError, Exception {
Moov sdk = Moov.builder()
.security(Security.builder()
.username("")
.password("")
.build())
.build();
CreateBrandResponse res = sdk.branding().create()
.accountID("7a621cf0-21cd-49cf-8540-3315211a509a")
.brandProperties(BrandProperties.builder()
.colors(BrandColors.builder()
.dark(BrandColor.builder()
.accent("#111111")
.build())
.light(BrandColor.builder()
.accent("#111111")
.build())
.build())
.build())
.call();
if (res.brandProperties().isPresent()) {
// handle response
}
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
xMoovVersion |
Optional<String> | ➖ | Specify an API version. API versioning follows the format vYYYY.QQ.BB, where - YYYY is the year- QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)- BB is the build number, starting at .01, for subsequent builds in the same quarter. - For example, v2024.01.00 is the initial release of the first quarter of 2024.The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release. |
accountID |
String | ✔️ | N/A |
brandProperties |
BrandProperties | ✔️ | N/A |
| Error Type | Status Code | Content Type |
|---|---|---|
| models/errors/GenericError | 400, 409 | application/json |
| models/errors/BrandValidationError | 422 | application/json |
| models/errors/APIException | 4XX, 5XX | */* |
Create or replace brand properties for the specified account.
To access this endpoint using an access token
you'll need to specify the /accounts/{accountID}/branding.write scope.
package hello.world;
import io.moov.sdk.Moov;
import io.moov.sdk.models.components.*;
import io.moov.sdk.models.errors.BrandValidationError;
import io.moov.sdk.models.errors.GenericError;
import io.moov.sdk.models.operations.UpsertBrandResponse;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws GenericError, BrandValidationError, Exception {
Moov sdk = Moov.builder()
.security(Security.builder()
.username("")
.password("")
.build())
.build();
UpsertBrandResponse res = sdk.branding().upsert()
.accountID("87673c22-1b80-4b69-b5bb-e92af8dcce02")
.brandProperties(BrandProperties.builder()
.colors(BrandColors.builder()
.dark(BrandColor.builder()
.accent("#111111")
.build())
.light(BrandColor.builder()
.accent("#111111")
.build())
.build())
.build())
.call();
if (res.brandProperties().isPresent()) {
// handle response
}
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
xMoovVersion |
Optional<String> | ➖ | Specify an API version. API versioning follows the format vYYYY.QQ.BB, where - YYYY is the year- QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)- BB is the build number, starting at .01, for subsequent builds in the same quarter. - For example, v2024.01.00 is the initial release of the first quarter of 2024.The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release. |
accountID |
String | ✔️ | N/A |
brandProperties |
BrandProperties | ✔️ | N/A |
| Error Type | Status Code | Content Type |
|---|---|---|
| models/errors/GenericError | 400, 409 | application/json |
| models/errors/BrandValidationError | 422 | application/json |
| models/errors/APIException | 4XX, 5XX | */* |
Get brand properties for the specified account.
To access this endpoint using an access token
you'll need to specify the /accounts/{accountID}/branding.read scope.
package hello.world;
import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.operations.GetBrandResponse;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws Exception {
Moov sdk = Moov.builder()
.security(Security.builder()
.username("")
.password("")
.build())
.build();
GetBrandResponse res = sdk.branding().get()
.accountID("b888f774-3e7c-4135-a18c-6b985523c4bc")
.call();
if (res.brandProperties().isPresent()) {
// handle response
}
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
xMoovVersion |
Optional<String> | ➖ | Specify an API version. API versioning follows the format vYYYY.QQ.BB, where - YYYY is the year- QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)- BB is the build number, starting at .01, for subsequent builds in the same quarter. - For example, v2024.01.00 is the initial release of the first quarter of 2024.The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release. |
accountID |
String | ✔️ | N/A |
| Error Type | Status Code | Content Type |
|---|---|---|
| models/errors/APIException | 4XX, 5XX | */* |
Updates the brand properties for the specified account.
To access this endpoint using an access token
you'll need to specify the /accounts/{accountID}/branding.write scope.
package hello.world;
import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.components.UpdateBrand;
import io.moov.sdk.models.errors.BrandValidationError;
import io.moov.sdk.models.errors.GenericError;
import io.moov.sdk.models.operations.UpdateBrandResponse;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws GenericError, BrandValidationError, Exception {
Moov sdk = Moov.builder()
.security(Security.builder()
.username("")
.password("")
.build())
.build();
UpdateBrandResponse res = sdk.branding().update()
.accountID("d95fa7f0-e743-42ce-b47c-b60cc78135dd")
.updateBrand(UpdateBrand.builder()
.build())
.call();
if (res.brandProperties().isPresent()) {
// handle response
}
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
xMoovVersion |
Optional<String> | ➖ | Specify an API version. API versioning follows the format vYYYY.QQ.BB, where - YYYY is the year- QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)- BB is the build number, starting at .01, for subsequent builds in the same quarter. - For example, v2024.01.00 is the initial release of the first quarter of 2024.The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release. |
accountID |
String | ✔️ | N/A |
updateBrand |
UpdateBrand | ✔️ | N/A |
| Error Type | Status Code | Content Type |
|---|---|---|
| models/errors/GenericError | 400, 409 | application/json |
| models/errors/BrandValidationError | 422 | application/json |
| models/errors/APIException | 4XX, 5XX | */* |