Skip to content
Navigation

Post a bulletin

Post a bulletin: something happening now that the organization's Agents must apply on calls, WhatsApp and web chat while it lasts (for example: there is no nutrition service; no appointments at the North site for four days; closed on Monday the 26th; a promotion). Write text as you would tell the Agents, including what they should offer instead. Omit agentId for every Agent, or name one Agent. Agents apply it from their next reply or call once startsAt (default now) is reached, until endsAt (omit it for no end). Resolve phrases such as 'for four days' or 'until Friday' in the organization's time zone (get_organization), ending whole days at local midnight. No Agent reads a bulletin before it starts: for Agents to know ahead (so they book nothing on a closed day), start it now and write the dates in the text. Fails with BULLETIN_PERIOD_INVALID when it would end before it starts or is already over, and BULLETIN_LIMIT_REACHED at 30 bulletins in force or scheduled.

  • Scope: raiz:agents:write
  • Credentials: an API key, a client-credentials token or a person's access token
  • Effect: writes; not idempotent: check the outcome before you retry
  • Limits: request body up to 32 KB, response up to 1 MB
  • CLI: arbol raiz bulletins create · MCP tool: raiz_bulletins_create
POST
https://api.getarbol.com/v1/raiz/bulletins

Authorization

  • Authorization
    string
    required
    Bearer <token>, where the token is an API key, a client-credentials token or a person's access token with the scope raiz:agents:write. Get an API key.

Request body JSON required

  • text
    string
    required

    What is happening and what the Agents should do about it, written as you would tell them. One situation per bulletin; long reference material belongs in Knowledge.

    maxLength: 1000 · minLength: 1 · pattern: \S
  • agentId
    optional
    string | null

    The one Agent that applies it; null for every Agent of the organization.

    pattern: ^agt_(?:[0-7][0-9a-hjkmnp-tv-z]{25}|(?:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|[a-f0-9]{32}))$
  • endsAt
    optional
    string | null

    When Agents stop applying it, later than its start and than now. Omit it or send null to keep it until it is deleted.

    format: date-time
  • startsAt
    optional
    string

    When Agents start applying it; default now. No Agent reads it before. For Agents to know ahead (so they book no appointment on a closed day), start it now and write the dates in the text.

    format: date-time

Returns

200

Successful operation.

JSON
  • success
    boolean
    required
  • data
    object
    required
    • agent
      required

      One of the following:

      • RaizBulletinAgent
        • id
          string
          required

          Agent id.

          pattern: ^agt_(?:[0-7][0-9a-hjkmnp-tv-z]{25}|(?:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|[a-f0-9]{32}))$
        • name
          string
          required
      • null
    • createdAt
      string
      required

      An instant in RFC 3339 format, in UTC.

      format: date-time
    • endsAt
      string | null
      required

      When Agents stop applying it, later than its start. Null keeps it until it is deleted.

      format: date-time
    • id
      string
      required

      Bulletin id.

      pattern: ^bul_(?:[0-7][0-9a-hjkmnp-tv-z]{25}|(?:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|[a-f0-9]{32}))$
    • startsAt
      string
      required

      When Agents start applying it.

      format: date-time
    • status
      scheduled
      or
      active
      or
      ended
      required

      scheduled: it has not started and no Agent reads it yet. active: Agents apply it. ended: its period is over and no Agent reads it.

    • text
      string
      required

      What is happening, in the words the Agents read.

    • updatedAt
      string
      required

      An instant in RFC 3339 format, in UTC.

      format: date-time
  • error
    null
    required
  • metadata
    object
    required
    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

400

INVALID_INPUT: The request does not match the published schema.
JSON
  • error
    required

    One of the following:

    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object

401

UNAUTHORIZED: A valid access token is required.
JSON
  • error
    required

    One of the following:

    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object

403

FORBIDDEN: The token does not authorize this operation.
JSON
  • error
    required

    One of the following:

    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object

404

  • NOT_FOUND: The requested operation does not exist.
  • RESOURCE_NOT_FOUND: The requested resource does not exist in this organization.
JSON
  • error
    required

    One of the following:

    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object

405

HTTP_METHOD_NOT_ALLOWED: The HTTP method is not supported for this resource.
JSON
  • error
    required

    One of the following:

    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object

409

BULLETIN_LIMIT_REACHED: The organization already has 30 bulletins in force or scheduled. End or delete one before adding another.
JSON
  • error
    required

    One of the following:

    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object

413

REQUEST_TOO_LARGE: The request exceeds the allowed size.
JSON
  • error
    required

    One of the following:

    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object

415

UNSUPPORTED_MEDIA_TYPE: The request content type is not supported.
JSON
  • error
    required

    One of the following:

    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object

422

BULLETIN_PERIOD_INVALID: A bulletin must end after it starts, and a new one must end in the future.
JSON
  • error
    required

    One of the following:

    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object

429

RATE_LIMITED: The request rate limit was exceeded. Try again later.
JSON
  • error
    required

    One of the following:

    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object

500

INTERNAL_ERROR: The service could not complete the operation.
JSON
  • error
    required

    One of the following:

    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object

502

OUTCOME_UNKNOWN: The operation may have been applied; check its result before repeating it.
JSON
  • error
    required

    One of the following:

    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object

503

UPSTREAM_UNAVAILABLE: The upstream service could not complete the request.
JSON
  • error
    required

    One of the following:

    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object

504

UPSTREAM_TIMEOUT: The upstream service did not respond before its deadline.
JSON
  • error
    required

    One of the following:

    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object
    • object

Escribe para buscar…

↑↓ navegar↵ seleccionarEsc cerrar