Agents

Update an automation

Changed on

Updates supplied fields; target and metadata replace the whole field.

post/agents/automations/{automation_id}

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/agents/automations/{automation_id}
  • Auth
    HTTP bearer

Path parameters

automation_idstring required

Request body

namestring
metadataobject

Replaces all metadata; omit to leave unchanged.

expressionstring

Only accepted for periodic automations.

timezonestring

Only accepted for periodic automations.

run_atinteger

A future Unix timestamp in seconds; accepted only before a one-time scheduled invocation exists.

Response

Successful response.

OR

Changes