Stop or restart sender photo sync

Stop or restart updating managed mailboxes with the sender photo. Stopping leaves applied photos in place; it is not a removal.

PUThttps://app.trygtm.com/api/v1/senders/photo/sync
Scope
write

Headers

Idempotency-Keystringoptional
A key unique to this write, up to 255 characters. A retry carrying the same key returns the first response instead of running again. Kept for 24 hours.

Body

enabledbooleanrequired
True to sync the photo to the mailboxes, false to stop.

Request

curl -X PUT https://app.trygtm.com/api/v1/senders/photo/sync \
  -H "Authorization: Bearer $TRYGTM_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true
  }'

Response

{
  "data": {
    "sync_enabled": false
  }
}

Was this page helpful?