Skip to content
digizeDocs

Add profile photos

POST
/api/v1/reviews/media
curl --request POST \
  --url https://digize.com/api/v1/reviews/media \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "items": [ { "kind": "photo", "category": "cover", "description": "example", "fileName": "example", "size": 1, "width": 1, "height": 1, "duration": 1, "imageId": "example", "videoKey": "example" } ] }'

Adds uploaded photos and videos to the Google Business Profile, which checks each before it shows.

Needs the reviews:write permission.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
string
>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example 

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
items
required
Array<object>
>= 1 items <= 20 items
object
kind
required
string
Allowed values: photo video
category
required
string
Allowed values: cover logo exterior interior product food_drink at_work team
description
required
string
<= 750 characters
fileName
required
string
<= 200 characters
size
required
number
<= 80000000
width
required
number
<= 20000
height
required
number
<= 20000
duration
required
Any of:
number
<= 60
imageId
required
Any of:
string
<= 200 characters
videoKey
required
Any of:
string
<= 400 characters

Responses

Section titled “Responses”

201

Section titled “201”

Done

Media typeapplication/json
object
rows
required
Array<object>
object
id
required
string
kind
required
string
Allowed values: photo video
category
required
string
Allowed values: cover logo exterior interior product food_drink at_work team
description
required
string
fileName
required
string
size
required
number
width
required
number
height
required
number
duration
required
number | null
source
required
string
Allowed values: owner customer
addedBy
required
string
addedAt
required
string format: date-time
views
required
number
status
required
string
Allowed values: live processing rejected
rejection
required
string | null
reported
required
boolean
previewUrl
required
string | null
videoKey
required
string | null
takedownUrl
required

Google’s form for reporting a customer’s photo.

string | null
pushState
required
Any of:
string
Allowed values: sending failed
total
required
number

Example 

{
  "rows": [
    {
      "kind": "photo",
      "category": "cover",
      "source": "owner",
      "status": "live",
      "pushState": "sending"
    }
  ]
}

400

Section titled “400”

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

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

401

Section titled “401”

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

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

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

403

Section titled “403”

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

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

404

Section titled “404”

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

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

409

Section titled “409”

A request with the same Idempotency-Key is still running (conflict).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

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

422

Section titled “422”

The Idempotency-Key was used with a different request.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

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

429

Section titled “429”

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

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