Briefing script edit

POST/v1/briefing-episodes/{id}/scripts/{revisionId}/edit

Signed-in sessionLaunch key product.briefingsOperation briefing_script_edit

Written and audio briefings from a person's work and memory: schedules, a listening queue, one player that keeps playing across the suite, a private feed and verified email delivery.

Path parameters

idstringRequired
revisionIdstringRequired

Body

contentobjectRequired
idempotencyKeystringRequired
expectedVersionnumberRequired

Returns

schemaVersion1Required
idstringRequired
versionnumberRequired
capabilitiesobject[]Required
episodeIdstringRequired
revisionNumbernumberRequired
contentobjectRequired
contentHashstringRequired
validationState"failed" | "not_started" | "passed" | "pending"Required
issueCodesstring[]Required
approvalIdstring

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}.

POST/v1/briefing-episodes/{id}/scripts/{revisionId}/edit

curl "$SPECIFY_API_ORIGIN/v1/briefing-episodes/<id>/scripts/<revisionId>/edit" \
  -X POST \
  -H "Authorization: Bearer $SPECIFY_SESSION_TOKEN" \
  -H "X-Specify-Account-Id: <accountId>" \
  -H "X-Specify-Service-Tenancy-Id: <serviceTenancyId>" \
  -H "Content-Type: application/json" \
  -d '{"content":{"version":"briefing-script-1","title":"<title>","chapters":[{"id":"<id>","title":"<title>"}],"turns":[{"id":"<id>","kind":"factual","text":"<text>","sequence":1,"claimId":"<claimId>","speakerId":"<speakerId>","chapterId":"<chapterId>"}],"omittedClaimIds":["<omittedClaimId>"]},"idempotencyKey":"retry-1","expectedVersion":1}'

Response

{
  "result": {
    "schemaVersion": 1,
    "id": "<id>",
    "version": 1,
    "capabilities": [
      {
        "action": "<action>",
        "allowed": true
      }
    ],
    "episodeId": "<episodeId>",
    "revisionNumber": 1,
    "content": {
      "version": "briefing-script-1",
      "title": "<title>",
      "chapters": [
        {
          "id": "<id>",
          "title": "<title>"
        }
      ],
      "turns": [
        {
          "id": "<id>",
          "sequence": 1,
          "chapterId": "<chapterId>",
          "speakerId": "<speakerId>",
          "kind": "factual",
          "claimId": "<claimId>",
          "text": "<text>"
        }
      ],
      "omittedClaimIds": [
        "<omittedClaimId>"
      ]
    },
    "contentHash": "<contentHash>",
    "validationState": "failed",
    "issueCodes": [
      "<issueCode>"
    ]
  }
}