Get the branding

GET

/api/v1/branding

curl --request GET \
  --url https://digize.com/api/v1/branding \
  --header 'x-api-key: <x-api-key>'

• Digize

The workspace’s logo, accent color, sender name, reply-to address, footer and whether emails say Powered by Digize.

Needs the settings:read permission.

Authorizations

• apiKey
• bearer

Responses

200

Done

Media typeapplication/json

object

logoImageId

required

string | null

logoUrl

required

string | null

accent

required

string

senderName

required

string

replyTo

required

string

hidePoweredBy

required

boolean

footer

required

string | null

Example ^generated

{
  "logoImageId": "example",
  "logoUrl": "example",
  "accent": "example",
  "senderName": "example",
  "replyTo": "example",
  "hidePoweredBy": true,
  "footer": "example"
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}