Destinations

Get a destination

One connected account: its status, and what videos it accepts.

get/destinations/{id}

Request

  • Base URL: https://api.deploy.social/v1
  • URL: https://api.deploy.social/v1/destinations/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Starts with dest_.

Response

The destination.

idstring required

The destination's id. Starts with dest_.

platformstring required
handlestring required
display_namestring nullable required
avatar_urlstring nullable required
statusstring required

active can be posted to. reconnect_required needs someone to reconnect it in Deploy first. disconnected was disconnected in Deploy. New values may be added.

status_reasonstring nullable required

Why it isn't active, when it isn't.

Example response

{
  "id": "dest_cmf3k1q7z0000ab12cd34ef56",
  "platform": "tiktok",
  "handle": "northsidestudio",
  "display_name": "Northside Studio",
  "status": "active",
  "media_limits": {
    "max_duration_sec": 180,
    "min_duration_sec": 3,
    "max_file_size_mb": 1024,
    "aspect_ratios": [
      "9:16"
    ],
    "containers": [
      "mp4",
      "mov"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.