Get brand
const url = 'https://api.optizmo.com/deploy/v1/brands/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.optizmo.com/deploy/v1/brands/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \ --header 'Authorization: <Authorization>'Fetches a single brand by id.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Id of the brand to fetch.
Responses
Section titled “ Responses ”The brand.
A brand in your account.
object
The brand id accepted by the contact subscriptions endpoints and by POST /deploy/v1/contacts’ brandIds field.
The brand’s from address. Omitted when not set.
The brand’s sending domain. Omitted when none is configured.
Email service providers the brand sends through, empty when none are attached.
object
The ESP id.
Verticals the brand falls under, empty when none are selected.
object
Numeric vertical code.
Name of the vertical.
A Deploy-hosted unsubscribe landing page.
object
Id of the Deploy-hosted unsubscribe landing page. Omitted when none is assigned.
A third-party unsubscribe page.
object
The brand’s custom List-Unsubscribe header. Omitted when none is configured.
Timestamp at which the brand was created.
Example
{ "name": "Acme", "verticals": [ { "id": 5, "label": "Technology" } ], "unsubscribeHandling": { "type": "Deploy" }}The brandId path parameter is not a valid UUID.
Error envelope returned by every v1 endpoint for failures, following RFC 9457
Problem Details with code and errors extensions.
object
URI identifying the problem type; dereferences to its documentation.
HTTP status code applicable to this problem.
Short, human-readable summary of the problem type.
Detailed explanation specific to this occurrence.
Error code identifying the specific error condition.
URI reference identifying this specific occurrence (the request URI).
Provides additional information when the error relates to specific request fields.
object
Detailed explanation for this specific field error.
JSON Pointer (RFC 6901) to the request body value that caused the error (e.g. /email, /attributes/firstName).
The URI query parameter that caused the error (e.g. pageSize, name[invalid]).
Example
{ "type": "https://docs.optizmo.com/deploy/error-codes#invalid_request_error", "status": 400, "title": "Invalid request", "detail": "brandId must be a UUID", "code": "invalid_request_error", "instance": "/deploy/v1/brands/not-a-uuid", "errors": [ { "detail": "brandId must be a UUID" } ]}Missing or invalid API key.
Error envelope returned by every v1 endpoint for failures, following RFC 9457
Problem Details with code and errors extensions.
object
URI identifying the problem type; dereferences to its documentation.
HTTP status code applicable to this problem.
Short, human-readable summary of the problem type.
Detailed explanation specific to this occurrence.
Error code identifying the specific error condition.
URI reference identifying this specific occurrence (the request URI).
Provides additional information when the error relates to specific request fields.
object
Detailed explanation for this specific field error.
JSON Pointer (RFC 6901) to the request body value that caused the error (e.g. /email, /attributes/firstName).
The URI query parameter that caused the error (e.g. pageSize, name[invalid]).
Example
{ "type": "https://docs.optizmo.com/deploy/error-codes#authentication_error", "status": 401, "title": "Authentication failed", "detail": "credentials required", "code": "authentication_error", "instance": "/deploy/v1/contacts"}Permission denied.
Error envelope returned by every v1 endpoint for failures, following RFC 9457
Problem Details with code and errors extensions.
object
URI identifying the problem type; dereferences to its documentation.
HTTP status code applicable to this problem.
Short, human-readable summary of the problem type.
Detailed explanation specific to this occurrence.
Error code identifying the specific error condition.
URI reference identifying this specific occurrence (the request URI).
Provides additional information when the error relates to specific request fields.
object
Detailed explanation for this specific field error.
JSON Pointer (RFC 6901) to the request body value that caused the error (e.g. /email, /attributes/firstName).
The URI query parameter that caused the error (e.g. pageSize, name[invalid]).
Example
{ "type": "https://docs.optizmo.com/deploy/error-codes#permission_error", "status": 403, "title": "Permission denied", "detail": "api key required", "code": "permission_error", "instance": "/deploy/v1/contacts"}No brand with this id exists in your account.
Error envelope returned by every v1 endpoint for failures, following RFC 9457
Problem Details with code and errors extensions.
object
URI identifying the problem type; dereferences to its documentation.
HTTP status code applicable to this problem.
Short, human-readable summary of the problem type.
Detailed explanation specific to this occurrence.
Error code identifying the specific error condition.
URI reference identifying this specific occurrence (the request URI).
Provides additional information when the error relates to specific request fields.
object
Detailed explanation for this specific field error.
JSON Pointer (RFC 6901) to the request body value that caused the error (e.g. /email, /attributes/firstName).
The URI query parameter that caused the error (e.g. pageSize, name[invalid]).
Example
{ "type": "https://docs.optizmo.com/deploy/error-codes#not_found_error", "status": 404, "title": "Not found", "detail": "Brand not found", "code": "not_found_error", "instance": "/deploy/v1/brands/497f6eca-6276-4993-bfeb-53cbbbba6f08"}