> ## Documentation Index > Fetch the complete documentation index at: https://docs.ctrl-hub.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a draft briefing > Replace a draft briefing's content and targeting. A sent or archived briefing cannot be changed: the request is refused with 409 Conflict. Requires `briefings:update` on the organisation that owns the briefing. ## OpenAPI ````yaml /api-reference/openapi.yaml put /v3/briefings/{briefing_id} openapi: 3.1.0 info: contact: email: support@ctrl-hub.com name: Ctrl Hub url: https://www.ctrl-hub.com description: > Ctrl Hub is the all-in-one platform for high-risk industries like utilities, construction, infrastructure, and renewables. We help teams manage everything from risk assessments and HAVS exposure to vehicle and equipment checks, with a guaranteed minimum of 200% ROI. license: name: MIT License url: https://opensource.org/licenses/MIT summary: An API for managing your compliance and risk posture termsOfService: https://www.ctrl-hub.com/terms-conditions title: Ctrl Hub version: 1.0.0 servers: - description: Production url: https://api.ctrl-hub.com - description: Staging url: https://api.ctrl-hub.dev - description: Development url: https://api.ctrl-hub.run security: [] tags: - description: | Actions are follow-ups assigned to users and teams, produced manually or by domain producers such as the data-capture workflow runner. name: Actions - description: | Audit events are the events that are logged by the system. name: Audit Events - description: | View the platform's health and availability. name: Status - description: > User-owned dashboards composed of cards on a fixed-slot bento layout. Cards come from a per-domain registry; the API stores their config as opaque JSON. name: Dashboards - description: > Copies of a mobile device's local database, sent by the operative on request so that people in their organisation can recover work that never reached the server. Kept for 30 days, and visible to people granted `device-backups:view` in the organisation each is filed against. name: Device Backups - description: > A record of documents the platform generated and handed over, retained as evidence of what was issued. `subject_type` says what kind of records an export covers, and it is what decides how the request is authorised: there is no export permission of its own, so if you can see the records you can export them. name: Exports - description: > Scheduled delivery of a saved query's results, as a CSV attachment or a summary email. Every run is retained with the file it sent, so what a recipient received stays retrievable. A report runs as the person who created it, under their own access. name: Reports - description: > Performance standards the platform defines, such as the gas Guaranteed Standards of Performance 3 and 13, and how an organisation's forms answer them. An organisation maps its form fields to a standard's inputs, and the mapping generates a saved query that reads the answers. name: Standards - description: | Manage appointments for work to be carried out with your customers name: Customer Appointments - description: | Manage interactions you have with your customers name: Customer Interactions - description: | Manage accounts for your customers name: Customer Accounts and Contacts - description: > Competency: the assessments, training items, inductions and registrations an organisation requires, and the specifications that combine them. name: Qualifications - description: | Workflows allow you to automate your processes. name: Workflows - description: | Manage documents name: Documents - description: | Manage documents name: Folders - description: | Manage documents name: Document Reviews - description: | Manage feature configurations for an organisation. name: Feature Configurations - description: | Equipment are the physical assets that an organisation manages. name: Equipment - description: | The central cost register: time-versioned rate codes for material, labour, contractor and miscellaneous spend, used to cost work against the job hierarchy. name: Costs - description: > Locations are places an organisation manages, optionally classified by a location type. name: Locations - description: > Bulk loads of locations from an uploaded CSV. An import matches rows on the organisation's own `reference`, so re-importing a corrected file updates what is already there rather than doubling the population, and the import record is the audit trail for the whole load: the bulk write path deliberately emits no per-row events. name: Location Imports - description: | Manage your forms and their schemas name: Forms, Schemas and Categories - description: | Create and view form submissions name: Submissions - description: | View the roles available in the system. name: IAM Roles - description: > IAM role groups can be assigned to principals to manage authorisation centrally. name: IAM Role Groups - description: | Manage service accounts which can access the API programmatically. name: Service Accounts - description: | Manage bridges between organisations. name: Bridges - description: | Manage settings for an organisation. name: Settings - description: | Manage teams within an organisation. name: Teams - description: > Manage who manages whom within an organisation, and the manager roles that say what a manager may do for their people. name: Management - description: | Manage job roles within an organisation. name: Job Roles - description: | Manage users and accounts. name: Users - description: | Invite and manage invitations to organisations. name: Invitations - description: > IAM grants are the asignment of roles or permissions to principals to manage resource access. name: IAM Grants - description: | View the permissions available in the system. name: IAM Permissions - description: | SSO providers are the identity providers for an organisation. name: SSO Providers - description: | Whoami returns information about the currently authenticated principal. name: Whoami - description: | Your personal inbox. A notification is the thing you receive: an envelope that carries what happened to one or more channels. Email is one of those channels, the inbox is another, and this is where the ones delivered to your inbox are listed, read, saved and archived. name: Notifications - description: | Manage your images name: Images - description: > AI agent personas that synthesise data into role-specific intelligent briefings. name: Agents - description: | Briefings generated by AI agents, including reasoning traces. name: Agent Briefings - description: > Notices an organisation sends to its own people and its contractors' people, who acknowledge that they have read and understood them. Replaces v2's bulletins. name: Briefings - description: > Organisations are the center point for most resources in the platform. Most other endpoints are subresources of an organisation. name: Organisations - description: | Permits managements, integrated with street manager. name: Permits - description: | Projects manage your work and governance. name: Projects - description: > Import templates allow users to save and reuse their CSV importer configuration as named templates. name: Import Templates - description: | Properties are the physical locations. name: Properties - description: | Search across schemes, work orders, and operations. name: Search - description: | Provides the API specification in JSON and YAML formats name: Specifications - description: | Streets are the physical roads. name: Streets - description: | Integration with street manager name: Street Manager - description: | Vehicles are the physical vehicles that an organisation manages. name: Vehicles - description: > Scheme contracts (also known as regions) group schemes allocated from the network to a contractor. name: Scheme Contracts - description: > Scheme shares allow you to share your schemes with other organisations across bridges. name: Scheme Shares - description: | Schemes are large programmes of work name: Schemes - description: > A Construction Phase Plan is the Principal Contractor's plan for managing health and safety on a scheme, under CDM 2015. Its risks are control measures written against the hazards on the scheme's Pre-Construction Information. Each section is owned by one duty-holder role. name: Construction Phase Plans - description: > A Pre-Construction Information pack is the Client's information about a scheme under CDM 2015, with its site hazards. A scheme has at most one. Each section is owned by one duty-holder role, and only that role can write it. name: Pre-Construction Information - description: > Site attendances record who was on site and when, whether or not they hold an account. There is no daily register resource: a day's register and who is currently on site are both queries over the attendances themselves. name: Site Attendances - description: | Work orders the component parts of a scheme. name: Work Orders - description: | Operations are the work to be carried out within work orders. name: Operations externalDocs: description: More documentation and resources url: https://docs.ctrl-hub.com paths: /v3/briefings/{briefing_id}: put: tags: - Briefings description: > Replace a draft briefing's content and targeting. A sent or archived briefing cannot be changed: the request is refused with 409 Conflict. Requires `briefings:update` on the organisation that owns the briefing. operationId: UpdateBriefing parameters: - $ref: '#/components/parameters/briefing_id' requestBody: $ref: '#/components/requestBodies/UpdateBriefing' responses: '200': $ref: '#/components/responses/GetBriefing' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorised' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '422': $ref: '#/components/responses/UnprocessableEntity' '500': $ref: '#/components/responses/InternalServerError' security: - Session: [] - OAuth2: [] - Cookie: [] components: parameters: briefing_id: name: briefing_id in: path required: true description: The unique identifier for the briefing. schema: type: string format: uuid example: 5d1f6a3e-2b4c-4e8a-9f70-1c2d3e4f5a6b requestBodies: UpdateBriefing: required: true description: >- The draft briefing's full content and targeting. An attribute left out is cleared. content: application/vnd.api+json: schema: type: object required: - data properties: data: type: object required: - id - type - attributes properties: id: type: string format: uuid type: type: string const: briefings attributes: type: object required: - title properties: title: type: string minLength: 1 maxLength: 200 body: type: string maxLength: 20000 description: >- The briefing's text, in a Markdown subset. Required before it can be sent. acknowledge_by: type: - string - 'null' format: date-time targeting: $ref: '#/components/schemas/BriefingTargeting' responses: GetBriefing: description: A briefing. headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: allOf: - type: object required: - data properties: data: $ref: '#/components/schemas/Briefing' - $ref: '#/components/schemas/JSONAPI' BadRequest: description: > There was an error with the request - this could be due to an invalid body, query parameters, or headers that were sent to the API. headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 98ca4a78-b66f-4234-9719-aaf832ee6669 status: '400' title: A validation error was encountered source: parameter: include meta: resource: wrong_value Unauthorised: description: Authentication failed headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 05fc9c8d-73b9-4697-9337-57f7a567a48f status: '401' title: You are not authorised to access this resource detail: In order to access this resource, you need the 'admin' role. code: AUTH.001 NotFound: description: The requested resource could not be found headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 7b4c8f12-3e9a-4d5b-8c6f-1a2b3c4d5e6f status: '404' title: Resource not found detail: The requested resource could not be found or does not exist. code: NOT_FOUND.001 Conflict: description: The request conflicts with the current state of the resource headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 8e2f9a34-b5c6-4d7e-9f8a-2b3c4d5e6f7g status: '409' title: Conflict detail: The request conflicts with the current state of the resource. code: CONFLICT.001 UnprocessableEntity: description: The request was understood but names something the server cannot act on headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: errors: - id: d26cc34a-ceb2-45fb-aba2-c61782f9ec39 status: '422' title: >- submitting organisation has no scheme share with the form's owning organisation detail: >- The request was understood but names something the server cannot act on. code: CH.001.054 InternalServerError: description: There was a problem handling the request on the server side headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: fe9d9a69-f0a7-4fdc-bb2c-176027f316c5 status: '500' title: Internal Server Error detail: An unexpected error occurred on the server. schemas: BriefingTargeting: type: object description: >- Who a briefing is addressed to. Targets in the sending organisation can be any mix of the whole organisation, teams, job roles and named members. Contractors' people can be addressed only by the sender's own shared job roles. properties: organisation: type: boolean description: Address every member of the sending organisation. default: false teams: type: array maxItems: 100 description: Teams in the sending organisation whose members are addressed. items: type: string format: uuid job_roles: type: array maxItems: 100 description: >- Job roles in the sending organisation whose holders there are addressed. items: type: string format: uuid members: type: array maxItems: 1000 description: Named members of the sending organisation. items: type: string format: uuid contractor_job_roles: type: array maxItems: 100 description: >- The sender's own shared job roles. Every member of a chosen contractor who holds one is addressed. items: type: string format: uuid contractor_organisations: type: array maxItems: 200 description: >- The contractors that contractor_job_roles reach. Empty means every organisation with an active bridge from the sender. Once sent, it is the list the briefing was sent to. items: type: string format: uuid Briefing: type: object description: >- A briefing an organisation sends to people, who acknowledge they have read and understood it. required: - id - type - attributes - relationships properties: id: type: string format: uuid description: The unique identifier of the briefing. type: type: string const: briefings attributes: $ref: '#/components/schemas/BriefingAttributes' relationships: $ref: '#/components/schemas/BriefingRelationships' meta: $ref: '#/components/schemas/BriefingMeta' JSONAPI: type: object description: JSON API response object required: - jsonapi properties: jsonapi: type: object required: - version properties: version: type: string description: The version of the JSON API specification examples: - '1.0' Error: type: object description: An error response properties: id: description: >- A unique identifier for this particular occurrence of the problem. If you encounter this, please provide us with the error ID and we can investigate it on our side. type: string format: uuid examples: - 05fc9c8d-73b9-4697-9337-57f7a567a48f status: description: >- The status code for the error. This might not match the HTTP status code if there are more that one errors to return with different status codes. type: string examples: - '401' - '500' title: description: A human readable title for the error. type: string examples: - You are not authorised to access this resource detail: description: >- Where there is more detail that we can provide outside of the title, we will provide it here. type: string examples: - In order to access this resource, you need the 'admin' role. code: description: >- A unique code for the error that may help us to diagnose the issue. Not all errors have codes, so this is usually empty. `CH.003.080` (403) means the organisation in `meta.organisation_id` requires two-factor authentication and the caller's session does not satisfy it. The caller must set up or use a second factor, or sign in through their organisation's SAML single sign-on. Other OIDC sign-ins do not count. type: string examples: - AUTH.001 - CH.003.080 source: description: A JSON object containing additional information about the error. type: object properties: pointer: description: >- A JSON Pointer to the value in the request that caused the error. type: string examples: - /data/attributes/email parameter: description: >- A string indicating which query parameter in the request caused the error. type: string examples: - include meta: description: >- A JSON object containing additional information about the error. When a parameter caused the error, there will be a `resource` property with the name of the resource that caused the error. When `code` is `CH.003.080`, `organisation_id` names the organisation that requires two-factor authentication, which the caller's session does not satisfy. type: object properties: resource: type: string description: >- The resource a parameter error relates to, such as an unsupported include. organisation_id: type: string format: uuid examples: - c000c344-8847-47da-a091-32e75902d3b1 additionalProperties: true required: - id - status - title BriefingAttributes: type: object description: Attributes of a briefing required: - title - body - status - source - acknowledge_by - sent_at - archived_at - attachments properties: title: type: string maxLength: 200 description: The briefing's title, at most 200 characters. examples: - Gas escape procedure update body: type: string maxLength: 20000 description: >- The briefing's text, in a Markdown subset (paragraphs, bold, lists and links), at most 20,000 characters. status: type: string description: >- A draft can be edited. A sent briefing is locked and can only be archived. readOnly: true enum: - draft - sent - archived source: type: string description: >- Where the briefing came from. `v2` marks one migrated from a v2 bulletin. readOnly: true enum: - v3 - v2 acknowledge_by: type: - string - 'null' format: date-time description: >- When recipients are expected to have acknowledged it. A recipient who has not acknowledged by then is overdue. sent_at: type: - string - 'null' format: date-time readOnly: true archived_at: type: - string - 'null' format: date-time readOnly: true targeting: $ref: '#/components/schemas/BriefingTargeting' attachments: type: array readOnly: true description: >- Files attached to the briefing, in the order they were added. Added and removed through the briefing's attachments while it is a draft, and locked with its content when it is sent. items: $ref: '#/components/schemas/BriefingAttachment' BriefingRelationships: type: object description: Relationships for a briefing required: - organisation - author properties: organisation: type: object description: The organisation that owns and sends the briefing. required: - data properties: data: $ref: '#/components/schemas/OrganisationRelationship' author: type: object description: The user who created the briefing. required: - data properties: data: $ref: '#/components/schemas/UserRelationship' BriefingMeta: type: object description: Meta information for a briefing properties: created_at: type: string format: date-time updated_at: type: string format: date-time stats: type: object description: >- The briefing's recipients as the requesting organisation sees them. The sender counts every recipient, a contractor only its own members. Absent from a recipient's own read. required: - recipients - viewed - acknowledged - overdue properties: recipients: type: integer viewed: type: integer description: Recipients who opened it, whether or not they acknowledged. acknowledged: type: integer overdue: type: integer description: Recipients who have not acknowledged by its acknowledge-by date. recipient: type: object description: >- The caller's own record, on a briefing sent to them. Absent otherwise. required: - id - state - overdue - sent_at - viewed_at - acknowledged_at properties: id: type: string format: uuid description: The caller's briefing-recipients record. state: type: string enum: - sent - viewed - acknowledged overdue: type: boolean sent_at: type: string format: date-time viewed_at: type: - string - 'null' format: date-time acknowledged_at: type: - string - 'null' format: date-time BriefingAttachment: type: object description: A file attached to a briefing. required: - id - name - content_type - size - added_at properties: id: type: string format: uuid description: The attachment's id, used to download or remove it. name: type: string description: The file's name. examples: - gas-escape-procedure.pdf content_type: type: string description: The file's media type. examples: - application/pdf size: type: integer format: int64 description: The file's size in bytes. added_at: type: string format: date-time OrganisationRelationship: type: object description: Represents a relationship to an organisation required: - id - type properties: id: type: string format: uuid description: The unique identifier of the organisation type: type: string const: organisations UserRelationship: type: object description: Represents a relationship to a user required: - id - type properties: id: type: string format: uuid description: The unique identifier of the user type: type: string const: users headers: content-type: description: The content type of the response schema: type: string example: application/vnd.api+json content-length: description: The length of the response body in bytes schema: type: integer format: int32 example: 1234 x-request-id: description: >- An ID that can be provided when reporting bugs to help identify the issue schema: type: string example: 8470f56af4cf25e22be08e72c70dbbdc securitySchemes: Session: description: | Session token for authentication. in: header name: X-Session-Token type: apiKey OAuth2: description: | OAuth2 token for authentication. flows: clientCredentials: scopes: {} tokenUrl: https://auth.ctrl-hub.com/oauth2/token type: oauth2 Cookie: description: | Cookie token for authentication. in: cookie name: ctrl_hub_session type: apiKey ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.