Contents

Brands

Each studio has one or more brands with ShootProof. It all depends on how they choose to organize their businesses. Some studios have a single brand, under which all their business takes place. Others like to separate the types of business they engage in under separate brands (i.e. portraits, weddings, etc.). They may use these brands to communicate with and sell to different customers.

No matter how a studio chooses to use ShootProof—whether through one brand or many—your app will manage most of a studio’s data through brands. Contacts, contracts, events, invoices, orders, and more are all handled through a brand.

List all of a studio’s brands

get
/studio/brand

Example Request

Query Parameters

Property Description
page
integer
  • default 1

The page of results to return.
rows
integer
  • default 25

The number of rows to return on each page of results.
sortBy
string
  • default "name"

The property by which items returned should be sorted.
sortType
string
enum
  • asc
  • desc
  • default "asc"

The direction in which sorting should occur.

Header Parameters

Property Description
Authentication required
string

The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

200 OK

Brand list response.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties
Property Description
items
brand[]
Brand

A collection of resources returned in the current result set.

Property Description
address required nullable
address
Address

The mailing address for this brand.
analyticsGoogle nullable
string

Google Analytics identifier in use on this brand's galleries.
autoSend
boolean

Indicates if orders will be automatically sent to labs without express studio approval
automationSendHour
integer
  • ≥ 0
  • ≤ 23

The hour during which email automations for this brand will be sent, relative to the brand's time zone.
created
string
date-time

The creation date of this brand.
customDomain nullable
string
hostname

A custom domain for this brand, if applicable.
email
string
email

The email address for this brand.
facebookFanPageUrl nullable
string
uri

The URL for this brand's Facebook fan page.
galleryDomain
string
uri

The domain for this brand's galleries.
hasEventCategories read-only
boolean

Does the brand contain categories for events?
homepageBrandTheme
brand-theme
Brand Theme

A brand theme.
homepageBrandThemeId
integer

The identifier for this brand's homepage brand theme.
id
integer

The identifier for this brand.
instagramUsername nullable
string

The Instagram username for this brand.
isDefault
boolean

Whether this is the default brand for the logged-in user's studio.
isEligibleToManagePlan
boolean

Whether this brand has the ability to manage the studio's plan.
isEmailVerified read-only
boolean

Has the brand verified the email address on record?
labCatalogs
lab-catalog[]
Lab Catalog

An array of lab catalogs to which this brand has access.
links required read-only
object
Links

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
locale
string

The locale defined for this brand.
name
string

The name of this brand.
phone nullable
string

The phone number for this brand.
subdomain
string

The ShootProof subdomain for this brand.
taxIdentifier nullable
string

The tax ID defined for this brand.
twitterHandle nullable
string

The Twitter username for this brand.
type
string
enum
  • brand
Type

The type of resource represented.
useDefaultWatermark
boolean

Whether or not the Brand's default watermark should be applied at upload time.
website nullable
string
uri

The URL for this brand's website.
links required read-only
object
Links

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
meta read-only
object

Metadata describing the current result set.

Property Description
currentPage
integer

The current page of results returned.
rows
integer

The number of rows returned per page for the current result set.
totalItems
integer

The total number of items in the result set. This may be affected by active search/filter parameters.
totalPages
integer

The total number of pages in the result set. This is affected by the rows parameter (totalItems / rows == totalPages).
type
string
enum
  • brand-collection
Type

The type of resource represented.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/BrandCollection"
        }
      }
    },
    "description": "Brand list response."
  }
}

Get a brand

get
/studio/brand/{brandId}

Example Request

Path Parameters

Property Description
brandId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

The brand identifier.

Header Parameters

Property Description
Authentication required
string

The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

200 OK

A brand.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties
Property Description
address required nullable
address
Address

The mailing address for this brand.
analyticsGoogle nullable
string

Google Analytics identifier in use on this brand's galleries.
autoSend
boolean

Indicates if orders will be automatically sent to labs without express studio approval
automationSendHour
integer
  • ≥ 0
  • ≤ 23

The hour during which email automations for this brand will be sent, relative to the brand's time zone.
created
string
date-time

The creation date of this brand.
customDomain nullable
string
hostname

A custom domain for this brand, if applicable.
email
string
email

The email address for this brand.
facebookFanPageUrl nullable
string
uri

The URL for this brand's Facebook fan page.
galleryDomain
string
uri

The domain for this brand's galleries.
hasEventCategories read-only
boolean

Does the brand contain categories for events?
homepageBrandTheme
brand-theme
Brand Theme

A brand theme.
homepageBrandThemeId
integer

The identifier for this brand's homepage brand theme.
id
integer

The identifier for this brand.
instagramUsername nullable
string

The Instagram username for this brand.
isDefault
boolean

Whether this is the default brand for the logged-in user's studio.
isEligibleToManagePlan
boolean

Whether this brand has the ability to manage the studio's plan.
isEmailVerified read-only
boolean

Has the brand verified the email address on record?
labCatalogs
lab-catalog[]
Lab Catalog

An array of lab catalogs to which this brand has access.
links required read-only
object
Links

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
locale
string

The locale defined for this brand.
name
string

The name of this brand.
phone nullable
string

The phone number for this brand.
subdomain
string

The ShootProof subdomain for this brand.
taxIdentifier nullable
string

The tax ID defined for this brand.
twitterHandle nullable
string

The Twitter username for this brand.
type
string
enum
  • brand
Type

The type of resource represented.
useDefaultWatermark
boolean

Whether or not the Brand's default watermark should be applied at upload time.
website nullable
string
uri

The URL for this brand's website.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Any error with a status code of 400 to 499 is considered a client error. This means it’s usually an error you can handle in your app, and then resend a modified request to the ShootProof API to get a successful response.

An error in the range of 500 to 599, on the other hand, is a different story. These errors usually mean that a problem occured on the server and resending the request with modifications will not fix the issue.

Pay careful attention to the status codes. We try to stick as close as possible to their defined semantics. For a complete list of HTTP status codes, take a look at the official HTTP Status Code Registry.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties
Property Description
detail
string

A longer description of of the error encountered.
info
object

Additional information that may be provided to aid in error resolution.

Property Description
reason
string
enum
  • contract-not-ready-to-countersign
  • event-photo-count-limit
  • plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug Description
contract-not-ready-to-countersign The contract is in a state that does not allow countersigning. Its status must be ready-to-countersign to perform this action.
event-photo-count-limit The event has reached the maximum number of photos allowed.
plan-does-not-allow-uploads The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.
status
integer

The HTTP status code associated with this error.
title
string

A short description of the error encountered.
type
string
uri

A namespace URI uniquely identifying the error type.
Validation Error Example
{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}
Forbidden Error Example
{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}
Not Found Error Example
{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}
Server Error Example
{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}
Unauthorized Error Example
{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Brand"
        }
      }
    },
    "description": "A brand."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Partially update a brand

patch
/studio/brand/{brandId}

Example Request

Path Parameters

Property Description
brandId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

The brand identifier.

Header Parameters

Property Description
Authentication required
string

The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The brand to update. Only provide those properties that need updating.

application/vnd.shootproof+json
Property Description
analyticsGoogle nullable
string
  • ≤ 30
  • ^UA-\d+-\d+$

The Google Analytics tracking ID to use for this brand. Used for Google Analytics tags present in galleries.
automationSendHour
integer
  • ≥ 0
  • ≤ 23

The hour during which email automations for this brand will be sent, relative to the brand's time zone.
customDomain nullable
  • ≤ 100

The custom domain to use for this brand. Must be a CNAME to clients.shootproof.com.
subdomain
  • ≥ 3
  • ≤ 60

Subdomain portion to use for this brand. yourbrand in yourbrand.shootproof.com.
taxIdentifier nullable
string

The tax ID defined for this brand.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "properties": {
          "analyticsGoogle": {
            "description": "The Google Analytics tracking ID to use for this brand.\nUsed for Google Analytics tags present in galleries.",
            "maximum": 30,
            "nullable": true,
            "pattern": "^UA-\\d+-\\d+$",
            "type": "string"
          },
          "automationSendHour": {
            "description": "The hour during which email automations for this brand will be sent, relative to the brand's time zone.",
            "maximum": 23,
            "minimum": 0,
            "type": "integer"
          },
          "customDomain": {
            "description": "The custom domain to use for this brand.  Must be a CNAME to `clients.shootproof.com`.",
            "example": "galleries.yourphotographystudio.com",
            "maximum": 100,
            "nullable": true
          },
          "subdomain": {
            "description": "Subdomain portion to use for this brand.  `yourbrand` in `yourbrand.shootproof.com`.",
            "example": "yourbrand",
            "maximum": 60,
            "minimum": 3,
            "nullable": false
          },
          "taxIdentifier": {
            "description": "The tax ID defined for this brand.",
            "nullable": true,
            "type": "string"
          }
        },
        "title": "Brand",
        "type": "object"
      }
    }
  },
  "description": "The brand to update. Only provide those properties that need updating.",
  "required": true
}

200 OK

The updated brand.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties
Property Description
address required nullable
address
Address

The mailing address for this brand.
analyticsGoogle nullable
string

Google Analytics identifier in use on this brand's galleries.
autoSend
boolean

Indicates if orders will be automatically sent to labs without express studio approval
automationSendHour
integer
  • ≥ 0
  • ≤ 23

The hour during which email automations for this brand will be sent, relative to the brand's time zone.
created
string
date-time

The creation date of this brand.
customDomain nullable
string
hostname

A custom domain for this brand, if applicable.
email
string
email

The email address for this brand.
facebookFanPageUrl nullable
string
uri

The URL for this brand's Facebook fan page.
galleryDomain
string
uri

The domain for this brand's galleries.
hasEventCategories read-only
boolean

Does the brand contain categories for events?
homepageBrandTheme
brand-theme
Brand Theme

A brand theme.
homepageBrandThemeId
integer

The identifier for this brand's homepage brand theme.
id
integer

The identifier for this brand.
instagramUsername nullable
string

The Instagram username for this brand.
isDefault
boolean

Whether this is the default brand for the logged-in user's studio.
isEligibleToManagePlan
boolean

Whether this brand has the ability to manage the studio's plan.
isEmailVerified read-only
boolean

Has the brand verified the email address on record?
labCatalogs
lab-catalog[]
Lab Catalog

An array of lab catalogs to which this brand has access.
links required read-only
object
Links

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
locale
string

The locale defined for this brand.
name
string

The name of this brand.
phone nullable
string

The phone number for this brand.
subdomain
string

The ShootProof subdomain for this brand.
taxIdentifier nullable
string

The tax ID defined for this brand.
twitterHandle nullable
string

The Twitter username for this brand.
type
string
enum
  • brand
Type

The type of resource represented.
useDefaultWatermark
boolean

Whether or not the Brand's default watermark should be applied at upload time.
website nullable
string
uri

The URL for this brand's website.

400 Bad Request

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties
Property Description
detail
string

A longer description of of the error encountered.
info
object

Additional information that may be provided to aid in error resolution.

Property Description
errors
object

If the error response is a result of validation errors, it will most likely be a 400 Bad Request response and contain this info.errors property. Each property name in the errors object is a property that failed validation. These properties contain objects with property names in the form of internal validation error message slugs paired with human-readable string values describing the validation failure. Each property may have multiple validation failure messages.
reason
string
enum
  • contract-not-ready-to-countersign
  • event-photo-count-limit
  • plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug Description
contract-not-ready-to-countersign The contract is in a state that does not allow countersigning. Its status must be ready-to-countersign to perform this action.
event-photo-count-limit The event has reached the maximum number of photos allowed.
plan-does-not-allow-uploads The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.
status
integer

The HTTP status code associated with this error.
title
string

A short description of the error encountered.
type
string
uri

A namespace URI uniquely identifying the error type.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Any error with a status code of 400 to 499 is considered a client error. This means it’s usually an error you can handle in your app, and then resend a modified request to the ShootProof API to get a successful response.

An error in the range of 500 to 599, on the other hand, is a different story. These errors usually mean that a problem occured on the server and resending the request with modifications will not fix the issue.

Pay careful attention to the status codes. We try to stick as close as possible to their defined semantics. For a complete list of HTTP status codes, take a look at the official HTTP Status Code Registry.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties
Property Description
detail
string

A longer description of of the error encountered.
info
object

Additional information that may be provided to aid in error resolution.

Property Description
reason
string
enum
  • contract-not-ready-to-countersign
  • event-photo-count-limit
  • plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug Description
contract-not-ready-to-countersign The contract is in a state that does not allow countersigning. Its status must be ready-to-countersign to perform this action.
event-photo-count-limit The event has reached the maximum number of photos allowed.
plan-does-not-allow-uploads The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.
status
integer

The HTTP status code associated with this error.
title
string

A short description of the error encountered.
type
string
uri

A namespace URI uniquely identifying the error type.
Validation Error Example
{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}
Forbidden Error Example
{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}
Not Found Error Example
{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}
Server Error Example
{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}
Unauthorized Error Example
{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Brand"
        }
      }
    },
    "description": "The updated brand."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

List all of a brand’s themes

get
/studio/brand/{brandId}/brand-theme

Example Request

Path Parameters

Property Description
brandId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

The brand identifier.

Query Parameters

Property Description
page
integer
  • default 1

The page of results to return.
rows
integer
  • default 25

The number of rows to return on each page of results.
sortBy
string
  • default "name"

The property by which items returned should be sorted.
sortType
string
enum
  • asc
  • desc
  • default "asc"

The direction in which sorting should occur.

Header Parameters

Property Description
Authentication required
string

The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

200 OK

Brand themes list response.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties
Property Description
items
brand-theme[]
Brand Theme

A collection of resources returned in the current result set.

Property Description
colorScheme
string
enum
  • dark
  • light

The color scheme for this brand theme.

ShootProof Identifier Description
dark A "dark" color scheme should be used when displaying this brand theme.
light A "light" color scheme should be used when displaying this brand theme.
created read-only
string
date-time
Signature

The date on which the entity was created.
emailBrandLogo nullable
brand-logo
Brand Logo

The brand logo for use in email messages (and any other place using a white/neutral background such as contracts and invoices).
eventBrandLogo nullable
brand-logo
Brand Logo

The brand logo for use in event presentation.
fontSet
string
enum
  • brandon
  • freeland
  • baskerville
  • blooming-elegant
  • bambusa-pro-regular
  • scandiebox-one

The font set for this brand theme.

ShootProof Identifier Primary Font Name Secondary Font Name Body Font Name
brandon Brandon Brandon Baskerville
freeland ProximaNova Freeland ProximaNova
baskerville Baskerville Baskerville OpenSans-Regular
blooming-elegant BloomingElegant-Regular BloomingElegant-Regular Brandon
bambusa-pro-regular BambusaPro-Regular BambusaPro-Regular OpenSans-Regular
scandiebox-one SBOne SBOne OpenSans-Regular
id
integer

The identifier of this brand theme.
links required read-only
object
Links

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name
string

The name of this brand theme.
primaryColor
string

The primary hex color code for this brand theme.
secondaryColor
string

The secondary hex color code for this brand theme.
type
string
enum
  • brand-theme

The type of object represented.
links required read-only
object
Links

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
meta read-only
object

Metadata describing the current result set.

Property Description
currentPage
integer

The current page of results returned.
rows
integer

The number of rows returned per page for the current result set.
totalItems
integer

The total number of items in the result set. This may be affected by active search/filter parameters.
totalPages
integer

The total number of pages in the result set. This is affected by the rows parameter (totalItems / rows == totalPages).
type
string
enum
  • brand-theme-collection
Type

The type of resource represented.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/BrandThemeCollection"
        }
      }
    },
    "description": "Brand themes list response."
  }
}

Get a brand theme

get
/studio/brand/{brandId}/brand-theme/{brandThemeId}

Example Request

Path Parameters

Property Description
brandId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

The brand identifier.
brandThemeId required
integer

The brand theme identifier.

Header Parameters

Property Description
Authentication required
string

The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

200 OK

A brand theme.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties
Property Description
colorScheme
string
enum
  • dark
  • light

The color scheme for this brand theme.

ShootProof Identifier Description
dark A "dark" color scheme should be used when displaying this brand theme.
light A "light" color scheme should be used when displaying this brand theme.
created read-only
string
date-time
Signature

The date on which the entity was created.
emailBrandLogo nullable
brand-logo
Brand Logo

The brand logo for use in email messages (and any other place using a white/neutral background such as contracts and invoices).
eventBrandLogo nullable
brand-logo
Brand Logo

The brand logo for use in event presentation.
fontSet
string
enum
  • brandon
  • freeland
  • baskerville
  • blooming-elegant
  • bambusa-pro-regular
  • scandiebox-one

The font set for this brand theme.

ShootProof Identifier Primary Font Name Secondary Font Name Body Font Name
brandon Brandon Brandon Baskerville
freeland ProximaNova Freeland ProximaNova
baskerville Baskerville Baskerville OpenSans-Regular
blooming-elegant BloomingElegant-Regular BloomingElegant-Regular Brandon
bambusa-pro-regular BambusaPro-Regular BambusaPro-Regular OpenSans-Regular
scandiebox-one SBOne SBOne OpenSans-Regular
id
integer

The identifier of this brand theme.
links required read-only
object
Links

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name
string

The name of this brand theme.
primaryColor
string

The primary hex color code for this brand theme.
secondaryColor
string

The secondary hex color code for this brand theme.
type
string
enum
  • brand-theme

The type of object represented.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Any error with a status code of 400 to 499 is considered a client error. This means it’s usually an error you can handle in your app, and then resend a modified request to the ShootProof API to get a successful response.

An error in the range of 500 to 599, on the other hand, is a different story. These errors usually mean that a problem occured on the server and resending the request with modifications will not fix the issue.

Pay careful attention to the status codes. We try to stick as close as possible to their defined semantics. For a complete list of HTTP status codes, take a look at the official HTTP Status Code Registry.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties
Property Description
detail
string

A longer description of of the error encountered.
info
object

Additional information that may be provided to aid in error resolution.

Property Description
reason
string
enum
  • contract-not-ready-to-countersign
  • event-photo-count-limit
  • plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug Description
contract-not-ready-to-countersign The contract is in a state that does not allow countersigning. Its status must be ready-to-countersign to perform this action.
event-photo-count-limit The event has reached the maximum number of photos allowed.
plan-does-not-allow-uploads The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.
status
integer

The HTTP status code associated with this error.
title
string

A short description of the error encountered.
type
string
uri

A namespace URI uniquely identifying the error type.
Validation Error Example
{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}
Forbidden Error Example
{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}
Not Found Error Example
{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}
Server Error Example
{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}
Unauthorized Error Example
{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/BrandTheme"
        }
      }
    },
    "description": "A brand theme."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Partially update a brand theme

patch
/studio/brand/{brandId}/brand-theme/{brandThemeId}

Example Request

Path Parameters

Property Description
brandId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

The brand identifier.
brandThemeId required
integer

The brand theme identifier.

Header Parameters

Property Description
Authentication required
string

The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The brand theme to update. Only provide those properties that need updating. Does not support logos.

application/vnd.shootproof+json
Property Description
colorScheme
string
enum
  • dark
  • light

The color scheme for this brand theme.

ShootProof Identifier Description
dark A "dark" color scheme should be used when displaying this brand theme.
light A "light" color scheme should be used when displaying this brand theme.
fontSet
string
enum
  • brandon
  • freeland
  • baskerville
  • blooming-elegant
  • bambusa-pro-regular
  • scandiebox-one

The font set for this brand theme.

ShootProof Identifier Primary Font Name Secondary Font Name Body Font Name
brandon Brandon Brandon Baskerville
freeland ProximaNova Freeland ProximaNova
baskerville Baskerville Baskerville OpenSans-Regular
blooming-elegant BloomingElegant-Regular BloomingElegant-Regular Brandon
bambusa-pro-regular BambusaPro-Regular BambusaPro-Regular OpenSans-Regular
scandiebox-one SBOne SBOne OpenSans-Regular
id
integer

The identifier of this brand theme.
name
string

The name of this brand theme.
primaryColor
string

The primary hex color code for this brand theme.
secondaryColor
string

The secondary hex color code for this brand theme.
type
string
enum
  • brand-theme

The type of object represented.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "description": "A brand theme.",
        "properties": {
          "colorScheme": {
            "description": "The color scheme for this brand theme.\n\n| ShootProof Identifier | Description |\n| --------------------- | ----------- |\n| `dark` | A \"dark\" color scheme should be used when displaying this brand theme. |\n| `light` | A \"light\" color scheme should be used when displaying this brand theme. |",
            "enum": [
              "dark",
              "light"
            ],
            "type": "string"
          },
          "fontSet": {
            "description": "The font set for this brand theme.\n\n| ShootProof Identifier | Primary Font Name | Secondary Font Name | Body Font Name |\n| --------------------- | ----------------- | ------------------- | -------------- |\n| `brandon` | Brandon | Brandon | Baskerville |\n| `freeland` | ProximaNova | Freeland | ProximaNova |\n| `baskerville` | Baskerville | Baskerville | OpenSans-Regular |\n| `blooming-elegant` | BloomingElegant-Regular | BloomingElegant-Regular | Brandon |\n| `bambusa-pro-regular` | BambusaPro-Regular | BambusaPro-Regular | OpenSans-Regular |\n| `scandiebox-one` | SBOne | SBOne | OpenSans-Regular |",
            "enum": [
              "brandon",
              "freeland",
              "baskerville",
              "blooming-elegant",
              "bambusa-pro-regular",
              "scandiebox-one"
            ],
            "type": "string"
          },
          "id": {
            "description": "The identifier of this brand theme.",
            "type": "integer"
          },
          "name": {
            "description": "The name of this brand theme.",
            "type": "string"
          },
          "primaryColor": {
            "description": "The primary hex color code for this brand theme.",
            "example": "777777",
            "type": "string"
          },
          "secondaryColor": {
            "description": "The secondary hex color code for this brand theme.",
            "example": "ffffff",
            "type": "string"
          },
          "type": {
            "description": "The type of object represented.",
            "enum": [
              "brand-theme"
            ],
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  },
  "description": "The brand theme to update. Only provide those properties that need updating. Does not support logos."
}

200 OK

The updated brand theme.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties
Property Description
colorScheme
string
enum
  • dark
  • light

The color scheme for this brand theme.

ShootProof Identifier Description
dark A "dark" color scheme should be used when displaying this brand theme.
light A "light" color scheme should be used when displaying this brand theme.
created read-only
string
date-time
Signature

The date on which the entity was created.
emailBrandLogo nullable
brand-logo
Brand Logo

The brand logo for use in email messages (and any other place using a white/neutral background such as contracts and invoices).
eventBrandLogo nullable
brand-logo
Brand Logo

The brand logo for use in event presentation.
fontSet
string
enum
  • brandon
  • freeland
  • baskerville
  • blooming-elegant
  • bambusa-pro-regular
  • scandiebox-one

The font set for this brand theme.

ShootProof Identifier Primary Font Name Secondary Font Name Body Font Name
brandon Brandon Brandon Baskerville
freeland ProximaNova Freeland ProximaNova
baskerville Baskerville Baskerville OpenSans-Regular
blooming-elegant BloomingElegant-Regular BloomingElegant-Regular Brandon
bambusa-pro-regular BambusaPro-Regular BambusaPro-Regular OpenSans-Regular
scandiebox-one SBOne SBOne OpenSans-Regular
id
integer

The identifier of this brand theme.
links required read-only
object
Links

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name
string

The name of this brand theme.
primaryColor
string

The primary hex color code for this brand theme.
secondaryColor
string

The secondary hex color code for this brand theme.
type
string
enum
  • brand-theme

The type of object represented.

400 Bad Request

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties
Property Description
detail
string

A longer description of of the error encountered.
info
object

Additional information that may be provided to aid in error resolution.

Property Description
errors
object

If the error response is a result of validation errors, it will most likely be a 400 Bad Request response and contain this info.errors property. Each property name in the errors object is a property that failed validation. These properties contain objects with property names in the form of internal validation error message slugs paired with human-readable string values describing the validation failure. Each property may have multiple validation failure messages.
reason
string
enum
  • contract-not-ready-to-countersign
  • event-photo-count-limit
  • plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug Description
contract-not-ready-to-countersign The contract is in a state that does not allow countersigning. Its status must be ready-to-countersign to perform this action.
event-photo-count-limit The event has reached the maximum number of photos allowed.
plan-does-not-allow-uploads The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.
status
integer

The HTTP status code associated with this error.
title
string

A short description of the error encountered.
type
string
uri

A namespace URI uniquely identifying the error type.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Any error with a status code of 400 to 499 is considered a client error. This means it’s usually an error you can handle in your app, and then resend a modified request to the ShootProof API to get a successful response.

An error in the range of 500 to 599, on the other hand, is a different story. These errors usually mean that a problem occured on the server and resending the request with modifications will not fix the issue.

Pay careful attention to the status codes. We try to stick as close as possible to their defined semantics. For a complete list of HTTP status codes, take a look at the official HTTP Status Code Registry.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties
Property Description
detail
string

A longer description of of the error encountered.
info
object

Additional information that may be provided to aid in error resolution.

Property Description
reason
string
enum
  • contract-not-ready-to-countersign
  • event-photo-count-limit
  • plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug Description
contract-not-ready-to-countersign The contract is in a state that does not allow countersigning. Its status must be ready-to-countersign to perform this action.
event-photo-count-limit The event has reached the maximum number of photos allowed.
plan-does-not-allow-uploads The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.
status
integer

The HTTP status code associated with this error.
title
string

A short description of the error encountered.
type
string
uri

A namespace URI uniquely identifying the error type.
Validation Error Example
{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}
Forbidden Error Example
{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}
Not Found Error Example
{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}
Server Error Example
{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}
Unauthorized Error Example
{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/BrandTheme"
        }
      }
    },
    "description": "The updated brand theme."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Update a brand theme

put
/studio/brand/{brandId}/brand-theme/{brandThemeId}

Example Request

Path Parameters

Property Description
brandId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

The brand identifier.
brandThemeId required
integer

The brand theme identifier.

Header Parameters

Property Description
Authentication required
string

The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The attachment parts of the multipart/mixed request MUST be named event-brand-logo and email-brand-logo. Other attachment names will not be accepted.

application/vnd.shootproof+json
Property Description
colorScheme
string
enum
  • dark
  • light

The color scheme for this brand theme.

ShootProof Identifier Description
dark A "dark" color scheme should be used when displaying this brand theme.
light A "light" color scheme should be used when displaying this brand theme.
emailBrandLogo nullable
brand-logo
Brand Logo

The brand logo for use in email messages (and any other place using a white/neutral background such as contracts and invoices).
eventBrandLogo nullable
brand-logo
Brand Logo

The brand logo for use in event presentation.
fontSet
string
enum
  • brandon
  • freeland
  • baskerville
  • blooming-elegant
  • bambusa-pro-regular
  • scandiebox-one

The font set for this brand theme.

ShootProof Identifier Primary Font Name Secondary Font Name Body Font Name
brandon Brandon Brandon Baskerville
freeland ProximaNova Freeland ProximaNova
baskerville Baskerville Baskerville OpenSans-Regular
blooming-elegant BloomingElegant-Regular BloomingElegant-Regular Brandon
bambusa-pro-regular BambusaPro-Regular BambusaPro-Regular OpenSans-Regular
scandiebox-one SBOne SBOne OpenSans-Regular
id
integer

The identifier of this brand theme.
name
string

The name of this brand theme.
primaryColor
string

The primary hex color code for this brand theme.
secondaryColor
string

The secondary hex color code for this brand theme.
type
string
enum
  • brand-theme

The type of object represented.
multipart/mixed
Property Description
colorScheme
string
enum
  • dark
  • light

The color scheme for this brand theme.

ShootProof Identifier Description
dark A "dark" color scheme should be used when displaying this brand theme.
light A "light" color scheme should be used when displaying this brand theme.
emailBrandLogo nullable
brand-logo
Brand Logo

The brand logo for use in email messages (and any other place using a white/neutral background such as contracts and invoices).
eventBrandLogo nullable
brand-logo
Brand Logo

The brand logo for use in event presentation.
fontSet
string
enum
  • brandon
  • freeland
  • baskerville
  • blooming-elegant
  • bambusa-pro-regular
  • scandiebox-one

The font set for this brand theme.

ShootProof Identifier Primary Font Name Secondary Font Name Body Font Name
brandon Brandon Brandon Baskerville
freeland ProximaNova Freeland ProximaNova
baskerville Baskerville Baskerville OpenSans-Regular
blooming-elegant BloomingElegant-Regular BloomingElegant-Regular Brandon
bambusa-pro-regular BambusaPro-Regular BambusaPro-Regular OpenSans-Regular
scandiebox-one SBOne SBOne OpenSans-Regular
id
integer

The identifier of this brand theme.
name
string

The name of this brand theme.
primaryColor
string

The primary hex color code for this brand theme.
secondaryColor
string

The secondary hex color code for this brand theme.
type
string
enum
  • brand-theme

The type of object represented.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/BrandTheme"
      }
    },
    "multipart/mixed": {
      "example": "--SP_BOUNDARY\nContent-Type: application/vnd.shootproof+json\n\n{\n    \"id\": 12345,\n    \"type\": \"brand-theme\",\n    \"name\": \"Test\",\n    \"primaryColor\": \"4fc12a\",\n    \"secondaryColor\": \"8a3b52\",\n    \"colorScheme\": \"light\",\n    \"fontSet\": \"brandon\"\n}\n\n--SP_BOUNDARY\nContent-Disposition: attachment; name=event-brand-logo; filename=image.jpg\nContent-Type: image/jpeg\n\n[binary data]\n\n--SP_BOUNDARY\nContent-Disposition: attachment; name=email-brand-logo; filename=image2.jpg\nContent-Type: image/jpeg\n\n[binary data]\n\n--SP_BOUNDARY--",
      "schema": {
        "$ref": "#/components/schemas/BrandTheme"
      }
    }
  },
  "description": "The attachment parts of the `multipart/mixed` request MUST be named\n`event-brand-logo` and `email-brand-logo`. Other attachment names\nwill not be accepted."
}

200 OK

The updated brand theme.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties
Property Description
colorScheme
string
enum
  • dark
  • light

The color scheme for this brand theme.

ShootProof Identifier Description
dark A "dark" color scheme should be used when displaying this brand theme.
light A "light" color scheme should be used when displaying this brand theme.
created read-only
string
date-time
Signature

The date on which the entity was created.
emailBrandLogo nullable
brand-logo
Brand Logo

The brand logo for use in email messages (and any other place using a white/neutral background such as contracts and invoices).
eventBrandLogo nullable
brand-logo
Brand Logo

The brand logo for use in event presentation.
fontSet
string
enum
  • brandon
  • freeland
  • baskerville
  • blooming-elegant
  • bambusa-pro-regular
  • scandiebox-one

The font set for this brand theme.

ShootProof Identifier Primary Font Name Secondary Font Name Body Font Name
brandon Brandon Brandon Baskerville
freeland ProximaNova Freeland ProximaNova
baskerville Baskerville Baskerville OpenSans-Regular
blooming-elegant BloomingElegant-Regular BloomingElegant-Regular Brandon
bambusa-pro-regular BambusaPro-Regular BambusaPro-Regular OpenSans-Regular
scandiebox-one SBOne SBOne OpenSans-Regular
id
integer

The identifier of this brand theme.
links required read-only
object
Links

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name
string

The name of this brand theme.
primaryColor
string

The primary hex color code for this brand theme.
secondaryColor
string

The secondary hex color code for this brand theme.
type
string
enum
  • brand-theme

The type of object represented.

400 Bad Request

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties
Property Description
detail
string

A longer description of of the error encountered.
info
object

Additional information that may be provided to aid in error resolution.

Property Description
errors
object

If the error response is a result of validation errors, it will most likely be a 400 Bad Request response and contain this info.errors property. Each property name in the errors object is a property that failed validation. These properties contain objects with property names in the form of internal validation error message slugs paired with human-readable string values describing the validation failure. Each property may have multiple validation failure messages.
reason
string
enum
  • contract-not-ready-to-countersign
  • event-photo-count-limit
  • plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug Description
contract-not-ready-to-countersign The contract is in a state that does not allow countersigning. Its status must be ready-to-countersign to perform this action.
event-photo-count-limit The event has reached the maximum number of photos allowed.
plan-does-not-allow-uploads The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.
status
integer

The HTTP status code associated with this error.
title
string

A short description of the error encountered.
type
string
uri

A namespace URI uniquely identifying the error type.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Any error with a status code of 400 to 499 is considered a client error. This means it’s usually an error you can handle in your app, and then resend a modified request to the ShootProof API to get a successful response.

An error in the range of 500 to 599, on the other hand, is a different story. These errors usually mean that a problem occured on the server and resending the request with modifications will not fix the issue.

Pay careful attention to the status codes. We try to stick as close as possible to their defined semantics. For a complete list of HTTP status codes, take a look at the official HTTP Status Code Registry.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties
Property Description
detail
string

A longer description of of the error encountered.
info
object

Additional information that may be provided to aid in error resolution.

Property Description
reason
string
enum
  • contract-not-ready-to-countersign
  • event-photo-count-limit
  • plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug Description
contract-not-ready-to-countersign The contract is in a state that does not allow countersigning. Its status must be ready-to-countersign to perform this action.
event-photo-count-limit The event has reached the maximum number of photos allowed.
plan-does-not-allow-uploads The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.
status
integer

The HTTP status code associated with this error.
title
string

A short description of the error encountered.
type
string
uri

A namespace URI uniquely identifying the error type.
Validation Error Example
{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}
Forbidden Error Example
{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}
Not Found Error Example
{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}
Server Error Example
{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}
Unauthorized Error Example
{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/BrandTheme"
        }
      }
    },
    "description": "The updated brand theme."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Get homepage settings for the brand

get
/studio/brand/{brandId}/homepage

Example Request

Path Parameters

Property Description
brandId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

The brand identifier.

Header Parameters

Property Description
Authentication required
string

The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

200 OK

Brand homepage settings for the brand.

This resource is always available for a brand, so it will never return a 400-series response.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties
Property Description
aboutImage required nullable
brand-homepage-about-image
Brand Homepage About Image

An image to display on the Brand Homepage with About info.
aboutText nullable
string

About text defined for the brand.

Typically formatted as HTML.
brandTheme
brand-theme
Brand Theme

A brand theme.
brandThemeId
integer

The identifier for this brand's homepage brand theme.
enableAboutPage
boolean

Whether to show the about page within the brand homepage.
enableContactForm
boolean

Whether to show the contact form within the brand homepage.
eventSortBy
string
enum
  • event-date-asc
  • event-date-desc
  • event-name-asc
  • event-name-desc
  • default "event-date-desc"

The type of sorting to apply when events layout is in use.

Events can be sorted by name or event date in ascending or descending order.

Defaults to displaying events in descending order by event date.
homepageText nullable
string

Introductory text that will appear to users when visiting the brand's homepage.

Typically formatted as HTML.
layout
enum
  • events
  • categories
  • widget
  • default "events"

The layout option to use for the brand homepage.

Note that the widget layout is only available if it's already in use for the given brand. Once the layout is using events or categories, widget layout cannot be used again.
links required read-only
object
Links

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
showAddress
boolean

Whether to show the brand's address information.
showEmail
boolean

Whether to show the brand's email address.
showHomepageText
boolean

Whether to show introductory text on the brand's homepage.
showPhone
boolean

Whether to show the brand's phone number.
showSocialMedia
boolean

Whether to show the brand's social media information.
showWebsite
boolean

Whether to show the brand's website URL.
type read-only
enum
  • brand-homepage
widgetShowEmail
boolean

When using widget layout, whether or not to show the brand's email address.
widgetShowEventList
boolean

When using widget layout, whether or not to show the brand's event list.
widgetShowSearch
boolean

When using widget layout, whether or not to show the search field.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/BrandHomepage"
        }
      }
    },
    "description": "Brand homepage settings for the brand.\n\nThis resource is always available for a brand, so it will never\nreturn a 400-series response."
  }
}

Update homepage settings for the brand

patch
/studio/brand/{brandId}/homepage

Example Request

Path Parameters

Property Description
brandId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

The brand identifier.

Header Parameters

Property Description
Authentication required
string

The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The brand homepage to update. Only provide those properties that need updating.

application/vnd.shootproof+json
Property Description
enableAboutPage
boolean

Whether to show the about page within the brand homepage.
enableContactForm
boolean

Whether to show the contact form within the brand homepage.
homepageText nullable
string

Introductory text that will appear to users when visiting the brand's homepage.

Typically formatted as HTML.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "description": "Settings to change for the brand homepage.\n\nAny properties in the brand homepage schema can be provided.",
        "properties": {
          "enableAboutPage": {
            "description": "Whether to show the about page within the brand homepage.",
            "type": "boolean"
          },
          "enableContactForm": {
            "description": "Whether to show the contact form within the brand homepage.",
            "type": "boolean"
          },
          "homepageText": {
            "description": "Introductory text that will appear to users when visiting the brand's homepage.\n\nTypically formatted as HTML.",
            "nullable": true,
            "type": "string"
          }
        },
        "title": "Brand Homepage",
        "type": "object"
      }
    }
  },
  "description": "The brand homepage to update.  Only provide those properties that need updating.",
  "required": true
}

200 OK

The complete set of brand homepage settings for the brand after the requested changes have been applied.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties
Property Description
aboutImage required nullable
brand-homepage-about-image
Brand Homepage About Image

An image to display on the Brand Homepage with About info.
aboutText nullable
string

About text defined for the brand.

Typically formatted as HTML.
brandTheme
brand-theme
Brand Theme

A brand theme.
brandThemeId
integer

The identifier for this brand's homepage brand theme.
enableAboutPage
boolean

Whether to show the about page within the brand homepage.
enableContactForm
boolean

Whether to show the contact form within the brand homepage.
eventSortBy
string
enum
  • event-date-asc
  • event-date-desc
  • event-name-asc
  • event-name-desc
  • default "event-date-desc"

The type of sorting to apply when events layout is in use.

Events can be sorted by name or event date in ascending or descending order.

Defaults to displaying events in descending order by event date.
homepageText nullable
string

Introductory text that will appear to users when visiting the brand's homepage.

Typically formatted as HTML.
layout
enum
  • events
  • categories
  • widget
  • default "events"

The layout option to use for the brand homepage.

Note that the widget layout is only available if it's already in use for the given brand. Once the layout is using events or categories, widget layout cannot be used again.
links required read-only
object
Links

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
showAddress
boolean

Whether to show the brand's address information.
showEmail
boolean

Whether to show the brand's email address.
showHomepageText
boolean

Whether to show introductory text on the brand's homepage.
showPhone
boolean

Whether to show the brand's phone number.
showSocialMedia
boolean

Whether to show the brand's social media information.
showWebsite
boolean

Whether to show the brand's website URL.
type read-only
enum
  • brand-homepage
widgetShowEmail
boolean

When using widget layout, whether or not to show the brand's email address.
widgetShowEventList
boolean

When using widget layout, whether or not to show the brand's event list.
widgetShowSearch
boolean

When using widget layout, whether or not to show the search field.

400 Bad Request

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties
Property Description
detail
string

A longer description of of the error encountered.
info
object

Additional information that may be provided to aid in error resolution.

Property Description
errors
object

If the error response is a result of validation errors, it will most likely be a 400 Bad Request response and contain this info.errors property. Each property name in the errors object is a property that failed validation. These properties contain objects with property names in the form of internal validation error message slugs paired with human-readable string values describing the validation failure. Each property may have multiple validation failure messages.
reason
string
enum
  • contract-not-ready-to-countersign
  • event-photo-count-limit
  • plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug Description
contract-not-ready-to-countersign The contract is in a state that does not allow countersigning. Its status must be ready-to-countersign to perform this action.
event-photo-count-limit The event has reached the maximum number of photos allowed.
plan-does-not-allow-uploads The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.
status
integer

The HTTP status code associated with this error.
title
string

A short description of the error encountered.
type
string
uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/BrandHomepage"
        }
      }
    },
    "description": "The complete set of brand homepage settings for the brand after\nthe requested changes have been applied."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Delete the About image for the brand homepage

delete
/studio/brand/{brandId}/homepage/about-image

Example Request

Path Parameters

Property Description
brandId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

The brand identifier.

Header Parameters

Property Description
Authentication required
string

The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

204 No Content

The resource was successfully deleted.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "204": {
    "$ref": "#/components/responses/deleteSuccess"
  }
}

Update the About image for the brand homepage

Updates the Brand Homepage About Image object, to be displayed on the Brand Homepage with About info.

put
/studio/brand/{brandId}/homepage/about-image

Example Request

Path Parameters

Property Description
brandId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

The brand identifier.

Header Parameters

Property Description
Authentication required
string

The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

multipart/mixed
Property Description
type
string
enum
  • brand-homepage-about-image

The type of object represented.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "content": {
    "multipart/mixed": {
      "example": "--SP_BOUNDARY\nContent-Type: application/vnd.shootproof+json\n\n{\n    \"type\": \"brand-homepage-about-image\"\n}\n\n--SP_BOUNDARY\nContent-Disposition: attachment; filename=image.jpg\nContent-Type: image/jpeg\n\n[binary data]\n\n--SP_BOUNDARY--",
      "schema": {
        "$ref": "#/components/schemas/BrandHomepageAboutImage"
      }
    }
  }
}

200 OK

The successfully-updated Brand Homepage About Image object.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties
Property Description
displayUrl read-only
object

Display URLs for this image.

Property Description
large
string
uri

A URL for a large-sized version of the image.
medium
string
uri

A URL for a medium-sized version of the image.
thumb
string
uri

A URL for a thumbnail-sized version of the image.
type
string
enum
  • brand-homepage-about-image

The type of object represented.

400 Bad Request

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties
Property Description
detail
string

A longer description of of the error encountered.
info
object

Additional information that may be provided to aid in error resolution.

Property Description
errors
object

If the error response is a result of validation errors, it will most likely be a 400 Bad Request response and contain this info.errors property. Each property name in the errors object is a property that failed validation. These properties contain objects with property names in the form of internal validation error message slugs paired with human-readable string values describing the validation failure. Each property may have multiple validation failure messages.
reason
string
enum
  • contract-not-ready-to-countersign
  • event-photo-count-limit
  • plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug Description
contract-not-ready-to-countersign The contract is in a state that does not allow countersigning. Its status must be ready-to-countersign to perform this action.
event-photo-count-limit The event has reached the maximum number of photos allowed.
plan-does-not-allow-uploads The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.
status
integer

The HTTP status code associated with this error.
title
string

A short description of the error encountered.
type
string
uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/BrandHomepageAboutImage"
        }
      }
    },
    "description": "The successfully-updated Brand Homepage About Image object."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Lists all watermarks for the brand.

Returns a list of all watermarks for the brand. Query string parameters may be used to affect the response, including pagination, sorting, and filtering.

get
/studio/brand/{brandId}/watermark

Example Request

Path Parameters

Property Description
brandId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

The brand identifier.

Query Parameters

Property Description
page
integer
  • default 1

The page of results to return.
rows
integer
  • default 25

The number of rows to return on each page of results.
searchName
integer

A string with which to filter watermarks by name.
sortBy
string
enum
  • created
  • name
  • default "name"

The property by which items returned should be sorted.
sortType
string
enum
  • asc
  • desc
  • default "asc"

The direction in which sorting should occur.

Header Parameters

Property Description
Authentication required
string

The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

200 OK

Watermarks list response.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties
Property Description
items
watermark[]

A collection of resources returned in the current result set.

Property Description
created
string
date-time

The creation date of this watermark.
displayUrl read-only
object

An object of display demo URLs, identified by demo image ID.

Property Description
demoImage1
string
uri

A URL indicating a demo image depicting the watermark.
demoImage2
string
uri

A URL indicating a demo image depicting the watermark.
id
integer

The identifier for this watermark.
isDefault
boolean

Whether this watermark is the brand's default watermark.
links required read-only
object
Links

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name
string

The name of this watermark.
type
string
enum
  • watermark

The type of object represented.
links required read-only
object
Links

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
meta read-only
object

Metadata describing the current result set.

Property Description
currentPage
integer

The current page of results returned.
rows
integer

The number of rows returned per page for the current result set.
totalItems
integer

The total number of items in the result set. This may be affected by active search/filter parameters.
totalPages
integer

The total number of pages in the result set. This is affected by the rows parameter (totalItems / rows == totalPages).
type
string
enum
  • watermark-collection
Type

The model type for the list response object.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/WatermarkCollection"
        }
      }
    },
    "description": "Watermarks list response."
  }
}