templates

Change a saved template

Change a template's name, description or settings. Every field is optional and an absent one is left alone; settings is replaced WHOLE when it is sent, not merged, so a partial settings object silently drops what it leaves out. A template belonging to another account is 404.

put/templates/{id}

Request

  • Base URL: https://api.gogoscreen.com/api/v1
  • URL: https://api.gogoscreen.com/api/v1/templates/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring required

The template's id — the id a create call answered with, or one from templates.list. A template id is not a uuid.

Headers

Idempotency-Keystring required

1–128 characters, unique to this request. A retry with the same key and the same body returns the STORED response with Idempotent-Replayed: true; the same key with a different body is 409 idempotency_conflict; a duplicate still in flight is 409 idempotency_in_progress. Claims expire after 24 hours.

Request body

descriptionstring
namestring
settingsobject

The render settings this template pins: limits, voice, length preset, orientation, capture, language, background, voice speed. Open shape, may gain keys; ≤65536 bytes, ≤16 deep.

Response

Change a saved template

Changes

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