POSTapi.synup.com/api/v4/locations/photos

Upload Photos to a Location

This API allows you to add photos to a specific location. Photos can be of different types, including logos, cover photos, and additional images.

For more details, refer to Manage photos for your location.

Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Body

Name	Type	Required	Description
`input`	object	required
`input.locationId`	string	required	The ID of the location for which photos will be added
`input.photos`	array of object	required
`input.photos[].photo`	string	required	URL of the image
`input.photos[].type`	string	required	Type of photo `LOGOCOVERADDITIONAL`

Request

curl -X POST 'https://api.synup.com/api/v4/locations/photos' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "input": {
    "locationId": "TG9jYXRpb246MTA4NzIxMQ==",
    "photos": [
      {
        "photo": "https://via.placeholder.com/250?text=LOGO+Placeholder",
        "type": "LOGO"
      },
      {
        "photo": "https://via.placeholder.com/800x400?text=COVER+Placeholder",
        "type": "COVER"
      },
      {
        "photo": "https://via.placeholder.com/600x400?text=ADDITIONAL+Image",
        "type": "ADDITIONAL"
      }
    ]
  }
}'

const res = await fetch('https://api.synup.com/api/v4/locations/photos', {
  method: 'POST',
  headers: {
    Authorization: 'API YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "input": {
      "locationId": "TG9jYXRpb246MTA4NzIxMQ==",
      "photos": [
        {
          "photo": "https://via.placeholder.com/250?text=LOGO+Placeholder",
          "type": "LOGO"
        },
        {
          "photo": "https://via.placeholder.com/800x400?text=COVER+Placeholder",
          "type": "COVER"
        },
        {
          "photo": "https://via.placeholder.com/600x400?text=ADDITIONAL+Image",
          "type": "ADDITIONAL"
        }
      ]
    }
  }),
});
const data = await res.json();

import requests
res = requests.post(
    "https://api.synup.com/api/v4/locations/photos",
    headers={
        "Authorization": "API YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
      "input": {
        "locationId": "TG9jYXRpb246MTA4NzIxMQ==",
        "photos": [
          {
            "photo": "https://via.placeholder.com/250?text=LOGO+Placeholder",
            "type": "LOGO"
          },
          {
            "photo": "https://via.placeholder.com/800x400?text=COVER+Placeholder",
            "type": "COVER"
          },
          {
            "photo": "https://via.placeholder.com/600x400?text=ADDITIONAL+Image",
            "type": "ADDITIONAL"
          }
        ]
      }
    },
)
data = res.json()

req, _ := http.NewRequest("POST", "https://api.synup.com/api/v4/locations/photos", bytes.NewBufferString(payload))
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")

res, err := http.DefaultClient.Do(req)

Responses

Status	Description
`200`
`400`
`x-200:Example Response (Over 30 Photos)`

Example response (generated from the schema)

{
  "data": {
    "addLocationPhotos": {
      "success": true,
      "errors": null,
      "photos": [
        {
          "databaseId": 0,
          "fileSize": 0,
          "id": "string",
          "name": "string",
          "starred": null,
          "thumbnailUrl": "string",
          "type": "string",
          "url": "string",
          "publisherOverride": "string"
        }
      ],
      "request": {
        "requestId": null,
        "status": null
      },
      "clientMutationId": null
    }
  }
}

Response body

Name	Type	Required
`data`	object	required
`data.addLocationPhotos`	object	required
`data.addLocationPhotos.success`	boolean	required
`data.addLocationPhotos.errors`	null	required
`data.addLocationPhotos.photos`	array of object	required
`data.addLocationPhotos.photos[].databaseId`	integer	required
`data.addLocationPhotos.photos[].fileSize`	integer	required
`data.addLocationPhotos.photos[].id`	string	required
`data.addLocationPhotos.photos[].name`	string	required
`data.addLocationPhotos.photos[].starred`	null	required
`data.addLocationPhotos.photos[].thumbnailUrl`	string	required
`data.addLocationPhotos.photos[].type`	string	required
`data.addLocationPhotos.photos[].url`	string	required
`data.addLocationPhotos.photos[].publisherOverride`	string	required
`data.addLocationPhotos.request`	object	required
`data.addLocationPhotos.request.requestId`	null	required
`data.addLocationPhotos.request.status`	null	required
`data.addLocationPhotos.clientMutationId`	null	required