Sign in

v11

latestOpenAPI 3.1.12026-08-03174162.0 MB
Promoters

Update a promoter

Update a promoter using either its unique ID or URL-friendly slug

put/promoters/{key}

Path parameters

keystring required

Promoter key - either a unique ID (pmt_xxx format) or URL-friendly slug

Example:pmt_01jqpjksnsen9vprw95et60t2m

Request body

namestring

Display name of the promoter organization. Must be between 3 and 30 characters

slugstring

URL-friendly slug for the promoter organization. Must be unique and between 3 and 30 characters

teamIdstring

ID of the team that owns this promoter. Establishes team-based organization and permissions.

descriptionstring

Detailed description of the promoter organization. Omit to leave unchanged.

approval'PENDING' | 'APPROVED' | 'REJECTED'

Approval status of the promoter. PENDING: awaiting review, APPROVED: can create events, REJECTED: cannot operate

geohashstring

Geohash encoding of the promoter's location for efficient spatial queries

metadataobject

Flexible key-value metadata storage for custom configuration. Similar to Stripe's metadata API. Maximum 50 keys, key names up to 40 characters, values up to 500 characters.

locationIdstring

ID of an existing location to update to. Either locationId or googlePlaceId can be provided.

googlePlaceIdstring

Google Place ID to update location from. Either locationId or googlePlaceId can be provided.

Example request

{
  "name": "Session Services",
  "slug": "session-services",
  "teamId": "tem_01jqpjksnsen9vprw95et60t2m",
  "description": "This is only a test...",
  "approval": "APPROVED",
  "image": {
    "src": "https://assets.session.services/icon-bg.png",
    "alt": "Session Services Logo",
    "width": 800,
    "height": 800
  },
  "geohash": "r3gx1",
  "locationId": "loc_01jqpjksnsen9vprw95et60t2m",
  "googlePlaceId": "ChIJN1t_tDeuEmsRUsoyG83frY4"
}

Response

OK

Example response

{
  "promoter": {
    "id": "pmt_01jqpjksnsen9vprw95et60t2m",
    "createdAt": "2026-08-03T06:13:52.214Z",
    "updatedAt": "2026-08-03T06:13:52.214Z",
    "name": "Session Services",
    "slug": "session-services",
    "teamId": "tem_01jqpjksnsen9vprw95et60t2m",
    "description": "This is only a test...",
    "approval": "APPROVED",
    "image": {
      "src": "https://assets.session.services/my-image.jpg",
      "alt": "My Image",
      "width": 1080,
      "height": 1080
    },
    "location": {
      "id": "loc_01hk153x00eh99pagyydz03sbz",
      "googlePlaceId": "ChIJP3Sa8ziYEmsRUKgyFmh9AQM",
      "createdAt": "2026-08-03T06:13:52.214Z",
      "updatedAt": "2026-08-03T06:13:52.214Z",
      "name": "Watson's EQ",
      "address": "The, Entertainment Quarter, 1 Bent St, Moore Park NSW 2021, Australia",
      "city": "Moore Park",
      "state": "New South Wales",
      "postcode": "2021",
      "country": "Australia",
      "latitude": -33.8944593,
      "longitude": 151.2252255,
      "timeZone": "Australia/Sydney",
      "types": [
        "establishment",
        "point_of_interest",
        "stadium"
      ],
      "description": "Historic outdoor amphitheater known for summer concerts",
      "image": {
        "src": "https://assets.session.services/my-image.jpg",
        "alt": "My Image",
        "width": 1080,
        "height": 1080
      },
      "venue": {
        "image": {
          "src": "https://assets.session.services/my-image.jpg",
          "alt": "My Image",
          "width": 1080,
          "height": 1080
        }
      }
    },
    "geohash": "r3gx1",
    "tracking": {
      "fbId": "485739562847563",
      "gaId": "G-PSW1MY7HB4",
      "tikTokId": "BQCKPH3RC77U8GPMLJ5G"
    }
  }
}