Contents

Email

ShootProof helps brands keep in touch with their customers through sending email messages to event visitors, contacts attached to an event or invoice, and more.

In addition to sending email messages on demand, ShootProof allows brands to set up automated emails that are sent whenever certain activities take place, and each brand has full control over when these are sent and for what activities they are sent.

Send an email message to a contact

post
/studio/brand/{brandId}/contact/{contactId}/email

Example Request

Path Parameters

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

The brand identifier.
contactId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

The contact 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

application/vnd.shootproof+json
Property Description
body
string
  • ≤ 10000 characters

The message to include in the body of the email.
headline
string
  • ≤ 100 characters

The headline to use in the email body.
subject
string
  • ≤ 200 characters

The subject line for the email message.
type
string
enum
  • email
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.

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "allOf": [
          {
            "properties": {
              "buttonText": {
                "readOnly": true
              },
              "recipientEmails": {
                "readOnly": true
              }
            }
          },
          {
            "$ref": "#/components/schemas/StudioToClientEmail"
          }
        ]
      }
    }
  },
  "required": true
}

202 Accepted

On success, we respond with the contact to whom the email message was sent.

Headers
Header Description
Content-Location
string
uri

The URL to the contact that is located in the response body.
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 address for this contact.
birthDate nullable
string
date

The date on which this contact was born.
birthDateDisplay read-only
string
date

The date on which this contact was born, properly formatted according to the brand’s locale.
businessName nullable
string

The name for the business with which this contact is associated.
created read-only
string
date-time

The date on which this contact was created
email
string
email

The email address for this contact.
firstName nullable
string

The first name for this contact.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
lastName nullable
string

The last name for this contact.
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 nullable
string

The full name for this contact.
notes nullable
string

Notes made by the studio about this contact.
phone nullable
either
string
or
integer

The phone number for this contact.
refereeContacts read-only
contact[]
Contact Minimal

Contacts that have been referred by this contact.
referringContact nullable read-only
contact
Contact Minimal

The contact who referred this contact.
referringContactId nullable
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

The identifier for the contact who referred this contact.
resourceCounts read-only
object
Property Description
numContracts
integer

The number of contracts with which this contact is associated.
numEvents
integer

The number of events with which this contact is associated.
numInvoices
integer

The number of invoices with which this contact is associated.
tags
string[]
unique

Tags describing this contact.
thirdPartyId nullable
either
integer
or
string

The identifier for this contact in the source system from which it originated.
type
string
enum
  • contact
Type

The type of resource 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.

{
  "202": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Contact"
        }
      }
    },
    "description": "On success, we respond with the contact to whom the email message was\nsent.",
    "headers": {
      "Content-Location": {
        "description": "The URL to the contact that is located in the response body.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Send an email message to a contract’s contacts

post
/studio/brand/{brandId}/contract/{contractId}/email

Example Request

Path Parameters

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

The brand identifier.
contractId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

A contract 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 contract email object used to send an email message.

application/vnd.shootproof+json
Property Description
body
string
  • ≤ 10000 characters

The message to include in the body of the email.
buttonText
string
  • ≤ 25 characters

The text for the call-to-action button in the email body.
headline
string
  • ≤ 100 characters

The headline to use in the email body.
recipientEmails
string[]

Email address(es) to send the email to. If provided, must be an array of valid email addresses. Optional, but may be required by child schemas.
subject
string
  • ≤ 200 characters

The subject line for the email message.
type
string
enum
  • email
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.

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/ContractEmail"
      }
    }
  },
  "description": "The contract email object used to send an email message.",
  "required": true
}

202 Accepted

On success, we respond with the contract for which the email message was sent.

Headers
Header Description
Content-Location
string
uri

The URL to the contract that is located in the response body.
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
activity read-only
object[]
Contract Activity

A list of activities that have occurred with this contract.
bodyContainsMagicBlank read-only
boolean

Indicates if the HTML body of the contract contains one or more 'magic blank' placeholder strings.
bodyHtml
string

The HTML body of the contract.
brandTheme read-only
brand-theme
Brand Theme

A brand theme.
brandThemeId
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
cancelationMessage nullable
string

Optional cancelation message to include in studio-to-client email sent when contract status moves to canceled state. As of this writing, value only used on PATCH requests.
contacts required read-only
contact-collection
Contact Collection Minimal

A collection of contacts associated with this contract
contractStatus
string
enum
  • draft
  • awaiting-client-signature
  • awaiting-studio-countersign
  • completed
  • canceled
  • expired
Contract Status

The current status of the contract.

Status Description
draft The contract is a draft and has not been sent to the client.
awaiting-client-signature The contract has been sent to the client and is awaiting their signature.
awaiting-studio-countersign The client has signed the contract, and it is ready for the studio to countersign.
completed The client and studio have both signed the contract.
canceled The studio has canceled the contract.
expired The expiration date specified on the contract has passed while the contract was in the draft or awaiting-client-signature states.
contractTemplate required read-only
contract-template
Contract Template
contractTemplateId nullable
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
created read-only
string
date-time

The creation date of this contract.
expirationDate
string
date-time

The date on which this contract expires.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
invoices read-only
invoice[]
Invoice Minimal

An array of linked invoices.
isEditable
boolean

Whether the contract is able to be edited.
isHidden
boolean

Whether the contract has been marked 'hidden'.
languageCode
string

The Unicode CLDR language tag for the language used in this contract.
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 for this contract.
publicId read-only
string
  • ^[a-fA-F0-9]{32}$

The public identifier for this contract (may be used in the portal website).
shootDate nullable
string
date-time

This contract covers a photo shoot or event that took place on this date.
signatureClient nullable read-only
contract-signature
Contract Signature

The contract signature for the client.
signatureStudio nullable read-only
contract-signature
Contract Signature

The contract signature for the studio.
type
string
enum
  • contract
Type

The type of resource 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.

{
  "202": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Contract"
        }
      }
    },
    "description": "On success, we respond with the contract for which the email message\nwas sent.",
    "headers": {
      "Content-Location": {
        "description": "The URL to the contract that is located in the response body.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

List email automation groups

get
/studio/brand/{brandId}/email/automation-group

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
filterCuratedUserAutomations
boolean

Filter curated email automation groups created by ShootProof and cloned by users
sortBy
string
enum
  • created
  • default "created"

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

Email automation groups.

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
email-automation-group[]
Email Automation Group

A collection of resources returned in the current result set.

Property Description
automations
email-automation[]
Email Automation

A collection of automated email messages that should be sent to a specified group of recipients at a configured time.
clonedFromId nullable
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

If cloned from another automation group, the identifier for the group from which this was cloned.
created read-only
string
date-time
Signature

The date on which the entity was created.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
isClonedFromSpAutomationGroup read-only
boolean

If this automation group was cloned from a ShootProof-created email automation group, then this property will be true.
linkedEventsCount read-only
integer

The total number of non-deleted events that are using the automation group.
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
  • ≤ 250 characters

The name for this email automation group.
type
string
enum
  • email-automation-group
Type

The type of resource 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
  • email-automation-group-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/EmailAutomationGroupCollection"
        }
      }
    },
    "description": "Email automation groups."
  }
}

Create an email automation group

post
/studio/brand/{brandId}/email/automation-group

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 email automation group to create.

application/vnd.shootproof+json
Property Description
automations
email-automation[]
Email Automation

A collection of automated email messages that should be sent to a specified group of recipients at a configured time.
clonedFromId nullable
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

If cloned from another automation group, the identifier for the group from which this was cloned.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
name
string
  • ≤ 250 characters

The name for this email automation group.
type
string
enum
  • email-automation-group
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.

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/EmailAutomationGroup"
      }
    }
  },
  "description": "The email automation group to create.",
  "required": true
}

201 Created

The new email automation group.

Headers
Header Description
Location
string
uri

The URL to the new email automation group.
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
automations
email-automation[]
Email Automation

A collection of automated email messages that should be sent to a specified group of recipients at a configured time.
clonedFromId nullable
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

If cloned from another automation group, the identifier for the group from which this was cloned.
created read-only
string
date-time
Signature

The date on which the entity was created.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
isClonedFromSpAutomationGroup read-only
boolean

If this automation group was cloned from a ShootProof-created email automation group, then this property will be true.
linkedEventsCount read-only
integer

The total number of non-deleted events that are using the automation group.
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
  • ≤ 250 characters

The name for this email automation group.
type
string
enum
  • email-automation-group
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.

{
  "201": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/EmailAutomationGroup"
        }
      }
    },
    "description": "The new email automation group.",
    "headers": {
      "Location": {
        "description": "The URL to the new email automation group.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  }
}

Delete an email automation group

delete
/studio/brand/{brandId}/email/automation-group/{emailAutomationGroupId}

Example Request

Path Parameters

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

The brand identifier.
emailAutomationGroupId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An email automation group 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.

403 Forbidden

The provided access credentials are not valid for the requested resource.

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.

404 Not Found

The requested resource could not be found.

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.

OpenAPI Schema

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

{
  "204": {
    "$ref": "#/components/responses/deleteSuccess"
  },
  "403": {
    "$ref": "#/components/responses/forbiddenError"
  },
  "404": {
    "$ref": "#/components/responses/notFoundError"
  }
}

Get an email automation group

get
/studio/brand/{brandId}/email/automation-group/{emailAutomationGroupId}

Example Request

Path Parameters

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

The brand identifier.
emailAutomationGroupId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An email automation group 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

Email automation group

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
automations
email-automation[]
Email Automation

A collection of automated email messages that should be sent to a specified group of recipients at a configured time.
clonedFromId nullable
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

If cloned from another automation group, the identifier for the group from which this was cloned.
created read-only
string
date-time
Signature

The date on which the entity was created.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
isClonedFromSpAutomationGroup read-only
boolean

If this automation group was cloned from a ShootProof-created email automation group, then this property will be true.
linkedEventsCount read-only
integer

The total number of non-deleted events that are using the automation group.
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
  • ≤ 250 characters

The name for this email automation group.
type
string
enum
  • email-automation-group
Type

The type of resource represented.

403 Forbidden

The provided access credentials are not valid for the requested resource.

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.

404 Not Found

The requested resource could not be found.

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.

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/EmailAutomationGroup"
        }
      }
    },
    "description": "Email automation group"
  },
  "403": {
    "$ref": "#/components/responses/forbiddenError"
  },
  "404": {
    "$ref": "#/components/responses/notFoundError"
  }
}

Update an email automation group

put
/studio/brand/{brandId}/email/automation-group/{emailAutomationGroupId}

Example Request

Path Parameters

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

The brand identifier.
emailAutomationGroupId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An email automation group 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 email automation group that will update the existing one.

application/vnd.shootproof+json
Property Description
automations
email-automation[]
Email Automation

A collection of automated email messages that should be sent to a specified group of recipients at a configured time.
clonedFromId nullable
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

If cloned from another automation group, the identifier for the group from which this was cloned.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
name
string
  • ≤ 250 characters

The name for this email automation group.
type
string
enum
  • email-automation-group
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.

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/EmailAutomationGroup"
      }
    }
  },
  "description": "The email automation group that will update the existing one.",
  "required": true
}

200 OK

The updated email automation group.

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
automations
email-automation[]
Email Automation

A collection of automated email messages that should be sent to a specified group of recipients at a configured time.
clonedFromId nullable
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

If cloned from another automation group, the identifier for the group from which this was cloned.
created read-only
string
date-time
Signature

The date on which the entity was created.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
isClonedFromSpAutomationGroup read-only
boolean

If this automation group was cloned from a ShootProof-created email automation group, then this property will be true.
linkedEventsCount read-only
integer

The total number of non-deleted events that are using the automation group.
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
  • ≤ 250 characters

The name for this email automation group.
type
string
enum
  • email-automation-group
Type

The type of resource 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.

403 Forbidden

The provided access credentials are not valid for the requested resource.

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.

404 Not Found

The requested resource could not be found.

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.

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/EmailAutomationGroup"
        }
      }
    },
    "description": "The updated email automation group."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  },
  "403": {
    "$ref": "#/components/responses/forbiddenError"
  },
  "404": {
    "$ref": "#/components/responses/notFoundError"
  }
}

List a brand’s email templates

get
/studio/brand/{brandId}/email/template

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
filterForEmailAutomation
boolean
  • default false

Filter email templates that can be used to create an email automation.

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

Email templates

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
email-template[]
Email Template

A collection of resources returned in the current result set.

Property Description
body
string

The user-entered body content of the email message, in HTML format.
buttonText
string

If a call-to-action button is displayed in the email, this is the text label that will appear on the button.
created read-only
string
date-time
Signature

The date on which the entity was created.
emailTemplateType
string
enum
  • contract-ready
  • documents-ready
  • email-admin-access-url-to-linked-contact
  • email-event-album-link
  • email-event-link
  • email-mobile-app-link
  • event-expiring-notice
  • event-released-to-linked-contact
  • event-released-to-visitors
  • event-upload-complete
  • event-visitor-message
  • invoice-final-payment-due-reminder
  • invoice-message
  • invoice-past-due-notice
  • invoice-ready
  • order-status-notice
Email Template Type

The constant ShootProof identifier for the email template type.

ShootProof Identifier Description
contract-ready Describes an email template that may be sent to a studio's client when a contract is ready to view.
documents-ready Describes an email template that may be sent to a studio's client when they have documents (i.e., invoice and contract) ready to view.
email-admin-access-url-to-linked-contact Describes an email template that may be used to give a linked contact access to an event while it's in pre-release.
email-event-album-link Describes an email template that may be used to share a specific album within an event.
email-event-link Describes an email template that may be used to share an event.
email-mobile-app-link Describes an email template that may be used to share a link to a mobile app with a studio's client.
event-expiring-notice Describes an email template that may be used to notify event visitors of an upcoming event expiration.
event-released-to-linked-contact Describes an email template that may be used to notify an event's linked contact that an event is now active.
event-released-to-visitors Describes an email template that may be used to notify event visitors that an event is now active.
event-upload-complete Describes an email template that may be used as an internal notification to the studio user that an upload is complete in their ShootProof account.
event-visitor-message Describes an email template that may be used to send general messages to event visitors.
invoice-final-payment-due-remainder Describes an email template that may be used to notify a studio's client that their final invoice payment will be due soon.
invoice-message Describes an email template that may be used to send general messages about an invoice to a studio's client.
invoice-past-due-notice Describes an email template that may be used to notify a studio's client that their invoice is past due.
invoice-ready Describes an email template that may be sent to a studio's client when an invoice is ready to view.
order-status-notice Describes an email template that may be sent to a studio's client when the status of their order changes.
headline
string

If a headline is displayed in the email, this is the text of that headline.
htmlEmail read-only
string

The full HTML email template, complete with in-lined CSS, headers, and footers. This may be used to render a representation of the email message, allowing the studio user an opportunity to preview their message before sending it.
htmlEmailCss read-only
string

CSS styles that may be used to style a representation of the email message, providing the studio user an opportunity to preview their message before sending it.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
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 email template.
resourceType nullable read-only
string
enum
  • contract
  • event
  • event-album
  • invoice
  • mobile-app
  • order
Email Template Type

If present, this describes the type of resource represented by this email template.
subject
string

The email subject line to use for this template.
type
string
enum
  • email-template

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
  • email-template-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/EmailTemplateCollection"
        }
      }
    },
    "description": "Email templates"
  }
}

Get an email template

If the resourceType and resourceId query string parameters are present in the request, the variables within the email template properties will be replaced with appropriate values for the specified resource. This is provided for convenience to allow the studio user to view an email template as it might appear when sent to their clients.

get
/studio/brand/{brandId}/email/template/{emailTemplateId}

Example Request

Path Parameters

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

The brand identifier.
emailTemplateId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An email template identifier.

Query Parameters

Property Description
resourceId
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

The identifier of the resourceType that you wish to use when replacing variables in email template properties. If no resourceType is provided, then variables will appear in the properties unchanged.
resourceType
string
enum
  • contract
  • event
  • event-album
  • invoice
  • mobile-app
  • order

Identifies the resource type for the given resourceId. If no resourceId is provided, then variables will appear in the properties unchanged.

The resourceType must be valid for the template type requested.

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

An email template

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
body
string

The user-entered body content of the email message, in HTML format.
buttonText
string

If a call-to-action button is displayed in the email, this is the text label that will appear on the button.
created read-only
string
date-time
Signature

The date on which the entity was created.
emailTemplateType
string
enum
  • contract-ready
  • documents-ready
  • email-admin-access-url-to-linked-contact
  • email-event-album-link
  • email-event-link
  • email-mobile-app-link
  • event-expiring-notice
  • event-released-to-linked-contact
  • event-released-to-visitors
  • event-upload-complete
  • event-visitor-message
  • invoice-final-payment-due-reminder
  • invoice-message
  • invoice-past-due-notice
  • invoice-ready
  • order-status-notice
Email Template Type

The constant ShootProof identifier for the email template type.

ShootProof Identifier Description
contract-ready Describes an email template that may be sent to a studio's client when a contract is ready to view.
documents-ready Describes an email template that may be sent to a studio's client when they have documents (i.e., invoice and contract) ready to view.
email-admin-access-url-to-linked-contact Describes an email template that may be used to give a linked contact access to an event while it's in pre-release.
email-event-album-link Describes an email template that may be used to share a specific album within an event.
email-event-link Describes an email template that may be used to share an event.
email-mobile-app-link Describes an email template that may be used to share a link to a mobile app with a studio's client.
event-expiring-notice Describes an email template that may be used to notify event visitors of an upcoming event expiration.
event-released-to-linked-contact Describes an email template that may be used to notify an event's linked contact that an event is now active.
event-released-to-visitors Describes an email template that may be used to notify event visitors that an event is now active.
event-upload-complete Describes an email template that may be used as an internal notification to the studio user that an upload is complete in their ShootProof account.
event-visitor-message Describes an email template that may be used to send general messages to event visitors.
invoice-final-payment-due-remainder Describes an email template that may be used to notify a studio's client that their final invoice payment will be due soon.
invoice-message Describes an email template that may be used to send general messages about an invoice to a studio's client.
invoice-past-due-notice Describes an email template that may be used to notify a studio's client that their invoice is past due.
invoice-ready Describes an email template that may be sent to a studio's client when an invoice is ready to view.
order-status-notice Describes an email template that may be sent to a studio's client when the status of their order changes.
headline
string

If a headline is displayed in the email, this is the text of that headline.
htmlEmail read-only
string

The full HTML email template, complete with in-lined CSS, headers, and footers. This may be used to render a representation of the email message, allowing the studio user an opportunity to preview their message before sending it.
htmlEmailCss read-only
string

CSS styles that may be used to style a representation of the email message, providing the studio user an opportunity to preview their message before sending it.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
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 email template.
resourceType nullable read-only
string
enum
  • contract
  • event
  • event-album
  • invoice
  • mobile-app
  • order
Email Template Type

If present, this describes the type of resource represented by this email template.
subject
string

The email subject line to use for this template.
type
string
enum
  • email-template

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/EmailTemplate"
        }
      }
    },
    "description": "An email template"
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

List ShootProof-curated email automation groups

get
/studio/email/curated-automation-group

Example Request

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

Email automation groups curated by ShootProof.

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
curated-email-automation-group[]
Curated Email Automation Group

A collection of resources returned in the current result set.

Property Description
automations
curated-email-automation[]
Curated Email Automation

A collection of automated email messages that should be sent to a specified group of recipients at a configured time.
created read-only
string
date-time
Signature

The date on which the entity was created.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
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 for this email automation group.
type
string
enum
  • curated-email-automation-group
Type

The type of resource 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
  • curated-email-automation-group-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/CuratedEmailAutomationGroupCollection"
        }
      }
    },
    "description": "Email automation groups curated by ShootProof."
  }
}

Get a ShootProof-curated email automation group

get
/studio/email/curated-automation-group/{emailAutomationGroupId}

Example Request

Path Parameters

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

An email automation group 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

Email automation group curated by ShootProof.

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
automations
curated-email-automation[]
Curated Email Automation

A collection of automated email messages that should be sent to a specified group of recipients at a configured time.
created read-only
string
date-time
Signature

The date on which the entity was created.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
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 for this email automation group.
type
string
enum
  • curated-email-automation-group
Type

The type of resource represented.

404 Not Found

The requested resource could not be found.

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.

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/CuratedEmailAutomationGroup"
        }
      }
    },
    "description": "Email automation group curated by ShootProof."
  },
  "404": {
    "$ref": "#/components/responses/notFoundError"
  }
}

Copy a ShootProof-curated email automation group

Following the semantics of the HTTP COPY method, this will copy the ShootProof-curated email automation group identified by the request URI to the brand email automation group collection identified by the URI in the Destination header (e.g., https://api.shootproof.com/studio/brand/123/email/automation-group).

post
/studio/email/curated-automation-group/{emailAutomationGroupId}

Example Request

Path Parameters

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

An email automation group identifier.

Query Parameters

Property Description
method required
string
enum
  • COPY

The HTTP method overloading this POST request.

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.
Destination required
string
uri

The URI of the brand email automation group collection where a new email automation group based on this ShootProof-curated email automation group should be created.

201 Created

The new email automation group.

Headers
Header Description
Location
string
uri

The URL to the new email automation group.
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
automations
email-automation[]
Email Automation

A collection of automated email messages that should be sent to a specified group of recipients at a configured time.
clonedFromId nullable
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

If cloned from another automation group, the identifier for the group from which this was cloned.
created read-only
string
date-time
Signature

The date on which the entity was created.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
isClonedFromSpAutomationGroup read-only
boolean

If this automation group was cloned from a ShootProof-created email automation group, then this property will be true.
linkedEventsCount read-only
integer

The total number of non-deleted events that are using the automation group.
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
  • ≤ 250 characters

The name for this email automation group.
type
string
enum
  • email-automation-group
Type

The type of resource represented.

403 Forbidden

The provided access credentials are not valid for the requested resource.

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.

404 Not Found

The requested resource could not be found.

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.

409 Conflict

The request could not be completed due to a conflict with the current state of the target resource.

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.

OpenAPI Schema

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

{
  "201": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/EmailAutomationGroup"
        }
      }
    },
    "description": "The new email automation group.",
    "headers": {
      "Location": {
        "description": "The URL to the new email automation group.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "403": {
    "$ref": "#/components/responses/forbiddenError"
  },
  "404": {
    "$ref": "#/components/responses/notFoundError"
  },
  "409": {
    "$ref": "#/components/responses/conflictError"
  }
}

Get a list of email template types

get
/studio/email/template-type

Example Request

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

Email template types

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
email-template-type[]
Email Template Type

A collection of resources returned in the current result set.

Property Description
defaults nullable
object

The system default values for this email template type.

Property Description
body nullable
string

The default message body of this email template type. The message body includes HTML tags.
buttonText nullable
string

The default text label for the button used in the body of the email template.
buttonTextHelper nullable
string

Helper text provided to help the studio user understand the action taken when their client clicks on the button in the email message.
description nullable
string

A description of this email template type.
headline nullable
string

The default headline used in the body of the email template.
htmlEmail nullable
string

The full HTML email template, complete with in-lined CSS, headers, and footers.
htmlEmailCss nullable
string

The CSS that will be used to style the email message.
subject nullable
string

The default subject line for this email template type.
emailTemplateType
string
enum
  • contract-ready
  • documents-ready
  • email-admin-access-url-to-linked-contact
  • email-event-album-link
  • email-event-link
  • email-mobile-app-link
  • event-expiring-notice
  • event-released-to-linked-contact
  • event-released-to-visitors
  • event-upload-complete
  • event-visitor-message
  • invoice-final-payment-due-reminder
  • invoice-message
  • invoice-past-due-notice
  • invoice-ready
  • order-status-notice

The constant ShootProof identifier for the email template type.

ShootProof Identifier Description
contract-ready Describes an email template that may be sent to a studio's client when a contract is ready to view.
documents-ready Describes an email template that may be sent to a studio's client when they have documents (i.e., invoice and contract) ready to view.
email-admin-access-url-to-linked-contact Describes an email template that may be used to give a linked contact access to an event while it's in pre-release.
email-event-album-link Describes an email template that may be used to share a specific album within an event.
email-event-link Describes an email template that may be used to share an event.
email-mobile-app-link Describes an email template that may be used to share a link to a mobile app with a studio's client.
event-expiring-notice Describes an email template that may be used to notify event visitors of an upcoming event expiration.
event-released-to-linked-contact Describes an email template that may be used to notify an event's linked contact that an event is now active.
event-released-to-visitors Describes an email template that may be used to notify event visitors that an event is now active.
event-upload-complete Describes an email template that may be used as an internal notification to the studio user that an upload is complete in their ShootProof account.
event-visitor-message Describes an email template that may be used to send general messages to event visitors.
invoice-final-payment-due-remainder Describes an email template that may be used to notify a studio's client that their final invoice payment will be due soon.
invoice-message Describes an email template that may be used to send general messages about an invoice to a studio's client.
invoice-past-due-notice Describes an email template that may be used to notify a studio's client that their invoice is past due.
invoice-ready Describes an email template that may be sent to a studio's client when an invoice is ready to view.
order-status-notice Describes an email template that may be sent to a studio's client when the status of their order changes.
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.
resourceType nullable
string
enum
  • contract
  • event
  • event-album
  • invoice
  • mobile-app
  • order

If present, this describes the type of resource represented by this email template.
type
string
enum
  • email-template-type
Type

The type of resource 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
  • email-template-type-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/EmailTemplateTypeCollection"
        }
      }
    },
    "description": "Email template types"
  }
}

Returns an email template type

If the resourceType and resourceId query string parameters are present in the request, the variables within the properties of the defaults will be replaced with appropriate values for the specified resource. This is provided for convenience to allow the studio user to view an email template as it might appear when sent to their clients.

get
/studio/email/template-type/{emailTemplateTypeId}

Example Request

Path Parameters

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

An email template type identifier.

Query Parameters

Property Description
resourceId
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

The identifier of the resourceType that you wish to use when replacing variables in the system default values. If no resourceType is provided, then only the system default values are returned.
resourceType
string
enum
  • contract
  • event
  • event-album
  • invoice
  • mobile-app
  • order

Identifies the resource type for the given resourceId. If no resourceId is provided, then only the system default values are returned.

The resourceType must be valid for the template type requested.

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

An email template type

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
defaults nullable
object

The system default values for this email template type.

Property Description
body nullable
string

The default message body of this email template type. The message body includes HTML tags.
buttonText nullable
string

The default text label for the button used in the body of the email template.
buttonTextHelper nullable
string

Helper text provided to help the studio user understand the action taken when their client clicks on the button in the email message.
description nullable
string

A description of this email template type.
headline nullable
string

The default headline used in the body of the email template.
htmlEmail nullable
string

The full HTML email template, complete with in-lined CSS, headers, and footers.
htmlEmailCss nullable
string

The CSS that will be used to style the email message.
subject nullable
string

The default subject line for this email template type.
emailTemplateType
string
enum
  • contract-ready
  • documents-ready
  • email-admin-access-url-to-linked-contact
  • email-event-album-link
  • email-event-link
  • email-mobile-app-link
  • event-expiring-notice
  • event-released-to-linked-contact
  • event-released-to-visitors
  • event-upload-complete
  • event-visitor-message
  • invoice-final-payment-due-reminder
  • invoice-message
  • invoice-past-due-notice
  • invoice-ready
  • order-status-notice

The constant ShootProof identifier for the email template type.

ShootProof Identifier Description
contract-ready Describes an email template that may be sent to a studio's client when a contract is ready to view.
documents-ready Describes an email template that may be sent to a studio's client when they have documents (i.e., invoice and contract) ready to view.
email-admin-access-url-to-linked-contact Describes an email template that may be used to give a linked contact access to an event while it's in pre-release.
email-event-album-link Describes an email template that may be used to share a specific album within an event.
email-event-link Describes an email template that may be used to share an event.
email-mobile-app-link Describes an email template that may be used to share a link to a mobile app with a studio's client.
event-expiring-notice Describes an email template that may be used to notify event visitors of an upcoming event expiration.
event-released-to-linked-contact Describes an email template that may be used to notify an event's linked contact that an event is now active.
event-released-to-visitors Describes an email template that may be used to notify event visitors that an event is now active.
event-upload-complete Describes an email template that may be used as an internal notification to the studio user that an upload is complete in their ShootProof account.
event-visitor-message Describes an email template that may be used to send general messages to event visitors.
invoice-final-payment-due-remainder Describes an email template that may be used to notify a studio's client that their final invoice payment will be due soon.
invoice-message Describes an email template that may be used to send general messages about an invoice to a studio's client.
invoice-past-due-notice Describes an email template that may be used to notify a studio's client that their invoice is past due.
invoice-ready Describes an email template that may be sent to a studio's client when an invoice is ready to view.
order-status-notice Describes an email template that may be sent to a studio's client when the status of their order changes.
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.
resourceType nullable
string
enum
  • contract
  • event
  • event-album
  • invoice
  • mobile-app
  • order

If present, this describes the type of resource represented by this email template.
type
string
enum
  • email-template-type
Type

The type of resource 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/EmailTemplateType"
        }
      }
    },
    "description": "An email template type"
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Send an email message to refer others to ShootProof

post
/studio/referral/email

Example Request

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

application/vnd.shootproof+json
Property Description
body
string
  • ≤ 10000 characters

The message to include in the body of the email.
recipientEmails
string[]

Email address(es) to send the email to. If provided, must be an array of valid email addresses. Optional, but may be required by child schemas.
subject
string
  • ≤ 200 characters

The subject line for the email message.
type
string
enum
  • email
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.

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "allOf": [
          {
            "required": [
              "recipientEmails"
            ]
          },
          {
            "$ref": "#/components/schemas/BasicEmailMessage"
          }
        ]
      }
    }
  },
  "required": true
}

202 Accepted

On success, we respond with a collection of email messages sent.

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
email[]
Basic Email Message

A collection of resources returned in the current result set.

Property Description
body
string
  • ≤ 10000 characters

The message to include in the body of the email.
recipientEmails
string[]

Email address(es) to send the email to. If provided, must be an array of valid email addresses. Optional, but may be required by child schemas.
subject
string
  • ≤ 200 characters

The subject line for the email message.
type
string
enum
  • email
Type

The type of resource 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
  • email-collection
Type

The type of resource 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.

{
  "202": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/EmailCollection"
        }
      }
    },
    "description": "On success, we respond with a collection of email messages sent."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}