Sign in

Create a convoy

Changed on
post/v0/city/{cityName}/convoys

Request

  • The document declares no server URL.
  • Auth: none declared. Required headers: X-GC-Request

Path parameters

cityNamestring required

City name.

Headers

X-GC-Requeststring required

Anti-CSRF header required on mutation requests. Any non-empty value is accepted; the header's presence is what the server checks.

Idempotency-Keystring

Idempotency key for safe retries.

Request body

itemsstring[] nullable

Bead IDs to include.

rigstring

Rig name.

titlestring required

Convoy title.

Response

Created

assigneestring
close_reasonstring
created_atstring date-time required
defer_untilstring date-time
descriptionstring
ephemeralboolean
fromstring
idstring required
is_blockedboolean
issue_typestring required
labelsstring[] nullable
metadataobject
needsstring[] nullable
no_historyboolean
parentstring
priorityinteger
refstring
statusstring required
titlestring required
updated_atstring date-time

Changes