Get
Get
This endpoint is used to retrieve the details of a specific email customization you’ve created. Include the CustomizationId in your request JSON, and the response will contain the corresponding customization details.
GET PortalCustomization/Get Request Body
| Field | Type | Description |
|---|---|---|
| CustomizationId | Guid | A unique customization identifier generated by TaxBandits |
Response Body
| Field | Type | Description |
|---|---|---|
| CustomizationId | Guid | A unique customization identifier generated by TaxBandits |
| CustomizationNm | String | A unique customization name generated by TaxBandits |
| BusinessLogoUrl | String | The URL of the business logo image |
| FavIconUrl | String | The URL of the favicon image |
| LogoPosition | String | The position where your business logo will be placed |
| PrimaryColor | String | The primary color of the iframe page |
| SecondaryColor | String | The secondary color of the iframe page |
| InterviewFlow | Boolean | As an alternative to direct form entry, you can offer recipients an interview-style method to complete the W-9/W-8 form |
| ShowDownloadPage | Boolean | If TRUE, your recipients are allowed to download their form |
Request JSON
"PortalCustomization/Get?CustomizationId=94fd3f4e-69f5-40a9-bc27-a31d2364a1c4"
Response JSON
{
"CustomizationId": "94fd3f4e-69f5-40a9-bc27-a31d2364a1c4",
"CustomizationNm": "Customization 68",
"BusinessLogoURL": "https://www.spanenterprises.com/Content/Images/span.png",
"FavIconURL": "https://expressirsforms.s3.amazonaws.com/UserFiles/FormW9Customisation/0b0b2cf6-5577-48f4-bb73-f3ae6d354257_2082_images5.png",
"LogoPosition": "RIGHT",
"PrimaryColor": "#00FF00",
"SecondaryColor": "#FF00FF",
"InterviewFlow": true,
"ShowDownloadPage": true,
"Errors": null
}