Gladly

opencollection: 1.0.0
info:
  name: Gladly API
  version: '1.0'
request:
  auth:
    type: basic
    username: '{{username}}'
    password: '{{password}}'
items:
- info:
    name: Communications
    type: folder
  items:
  - info:
      name: Send SMS
      type: http
    http:
      method: POST
      url: https://{organization}.gladly.com/api/v1/api/v1/communications/sms
      body:
        type: json
        data: '{}'
    docs: 'To send an SMS message to a customer specified by a mobile phone number.


      Gladly can send outbound SMS messages globally. By default, your organization is set up to only allow access to your
      home country.  To send SMS messages to other countries, please contact [Gladly Support](https://help.gladly.com/implementation/docs/filing-a-support-issue)
      with a P4 designation.


      Please be aware that:

      - Any automated outbound text messages **must** comply with carrier [acceptable use policies](https://help.'
  - info:
      name: Send Email
      type: http
    http:
      method: POST
      url: https://{organization}.gladly.com/api/v1/api/v1/communications/email
      body:
        type: json
        data: '{}'
    docs: 'Used to send an email messages to a customer specified by an email address.


      Any items created using this API will not be considered part of a conversation, and are **non-routable** and **non-searchable**
      aside from the email address specified as part of the payload.

      '
- info:
    name: Conversations
    type: folder
  items:
  - info:
      name: Get Conversations for Customer
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/customers/:customerId/conversations
      params:
      - name: customerId
        value: gHufx-U3QqOmhvFuViceTw
        type: path
        description: Id of the customer to get all conversations for
    docs: 'Get the list of conversations for a customer.

      The list is not paginated and will return at most 100 conversations.

      The conversations are returned in ascending order by timestamp.

      The `Gladly-Limited-Data` header flag in the response will indicate if the customer has more conversations than returned.

      '
  - info:
      name: Get Conversation
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/conversations/:conversationId
      params:
      - name: conversationId
        value: 9BcE2O0DQ2ynGHRmk9FeoA
        type: path
        description: Id of the conversation to get
    docs: 'Get conversation metadata such as it''s assignee, topics, inbox, etc.

      '
  - info:
      name: Update Conversation
      type: http
    http:
      method: PATCH
      url: https://{organization}.gladly.com/api/v1/api/v1/conversations/:conversationId
      params:
      - name: conversationId
        value: 9BcE2O0DQ2ynGHRmk9FeoA
        type: path
        description: Id of the conversation
      body:
        type: json
        data: '{}'
    docs: 'Update conversation assignee, statusor both

      '
  - info:
      name: Create Item
      type: http
    http:
      method: POST
      url: https://{organization}.gladly.com/api/v1/api/v1/conversation-items
      body:
        type: json
        data: '{}'
    docs: 'To add items to the timeline for a customer specified by identifying information. If the customer doesn''t exist,
      a new customer profile is created.


      Any items created using this API will not be considered part of a conversation, and are **non-routable** and **non-searchable**
      aside from the mobile phone number or email address specified as part of the payload.

      '
  - info:
      name: Get Item
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/conversation-items/:itemId
      params:
      - name: itemId
        value: ''
        type: path
        description: 'id of the conversation item

          '
    docs: 'Returns the conversation item with the provided id.

      '
  - info:
      name: Delete Item
      type: http
    http:
      method: DELETE
      url: https://{organization}.gladly.com/api/v1/api/v1/conversation-items/:itemId
      params:
      - name: itemId
        value: ''
        type: path
        description: 'Id of the item to be deleted.

          '
    docs: 'To delete an item.


      Please note only items of type **CUSTOMER_ACTIVITY** may be deleted by this API.

      '
  - info:
      name: Get Media
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/conversation-items/:itemId/media/recording
      params:
      - name: itemId
        value: ''
        type: path
        description: 'id of the conversation item

          '
    docs: 'Returns the media file associated with the conversation item

      '
  - info:
      name: Get Voice Transcript
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/conversation-items/:itemId/voice-transcript
      params:
      - name: itemId
        value: ''
        type: path
        description: 'id of the conversation item

          '
    docs: 'Returns a transcript of a phone call or a voicemail

      '
  - info:
      name: Get Attachment
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/conversation-items/:itemId/attachments/:attachmentId
      params:
      - name: itemId
        value: ''
        type: path
        description: 'Id of the conversation item that contains the attachment.

          '
      - name: attachmentId
        value: ''
        type: path
        description: 'Id of the attachment to retrieve.

          '
    docs: 'Returns a redirect to the URL of the specified attachment on a conversation item.


      The response is a `303 See Other` redirect. Follow the redirect to download the attachment content.


      Attachments are available on conversation items with content types that support them, such as emails, chat messages,
      SMS messages, and custom channel messages.

      '
  - info:
      name: Create Item for Customer
      type: http
    http:
      method: POST
      url: https://{organization}.gladly.com/api/v1/api/v1/customers/:customerId/conversation-items
      params:
      - name: customerId
        value: ''
        type: path
        description: 'Id of the customer associated with this item.


          You can look up the id using the [Find customers](index.html#tag/Customers) API.

          '
      body:
        type: json
        data: '{}'
    docs: 'To add items to a customer''s timeline.


      Any items created using this API will not be considered part of a conversation, and are **non-routable** and **non-searchable**
      aside from the mobile phone number or email address specified as part of the payload.

      '
  - info:
      name: Delete Item for Customer
      type: http
    http:
      method: DELETE
      url: https://{organization}.gladly.com/api/v1/api/v1/customers/:customerId/conversation-items/:itemId
      params:
      - name: customerId
        value: ''
        type: path
        description: 'Id of the customer associated with this item.


          You can look up the id using the [Find customers](index.html#tag/Customers) API.

          '
      - name: itemId
        value: ''
        type: path
        description: 'Id of the item to be deleted.

          '
    docs: 'To delete an item.


      Please note only items of type **CUSTOMER_ACTIVITY** may be deleted by this API.

      '
  - info:
      name: List Items in Conversation
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/conversations/:conversationId/items
      params:
      - name: conversationId
        value: 9BcE2O0DQ2ynGHRmk9FeoA
        type: path
        description: Id of the conversation to get the timeline for
      - name: sessionId
        value: 5k04bYuTRGqyT6uoSQfWVA
        type: query
        description: Return only items whose `sessionId` matches the given value.
    docs: 'Get the list of items in the timeline of a conversation.

      The conversation represents a period of related interactions between a customer and your organization.

      The list is not paginated and will return at most 1000 items. The items are returned in ascending order by timestamp.

      The `Gladly-Limited-Data` header flag in the response will indicate if the conversation has more items than returned.


      The response can be filtered by session using the optional `sessionId` query parameter.

      '
  - info:
      name: Add Topics to Conversation
      type: http
    http:
      method: POST
      url: https://{organization}.gladly.com/api/v1/api/v1/conversations/:conversationId/topics
      params:
      - name: conversationId
        value: ''
        type: path
        description: 'Id of the conversation.

          '
      body:
        type: json
        data: '{}'
    docs: 'Adds a list of topics to the conversation. If a topic being added already exists on the conversation, that topic
      is ignored.

      '
  - info:
      name: Delete Topic From Conversation
      type: http
    http:
      method: DELETE
      url: https://{organization}.gladly.com/api/v1/api/v1/conversations/:conversationId/topics/:topicId
      params:
      - name: conversationId
        value: ''
        type: path
        description: 'Id of the conversation.

          '
      - name: topicId
        value: ''
        type: path
        description: 'Id of topic to be deleted from conversation.

          '
    docs: 'Delete a topic from a conversation.

      '
  - info:
      name: Add or Remove Freeform Topic
      type: http
    http:
      method: POST
      url: https://{organization}.gladly.com/api/v1/api/v1/customer-history/:customerId/conversations/:conversationId/custom-attributes
      params:
      - name: customerId
        value: ''
        type: path
        description: 'Id of the customer.

          '
      - name: conversationId
        value: ''
        type: path
        description: 'Id of the conversation.

          '
      body:
        type: json
        data: '{}'
    docs: 'Adds or removes a list of freeform topics to the conversation. If the freeform topic being added already exists
      on the conversation, that topic is ignored.

      '
  - info:
      name: Add Note
      type: http
    http:
      method: POST
      url: https://{organization}.gladly.com/api/v1/api/v1/conversations/:conversationId/notes
      params:
      - name: conversationId
        value: ''
        type: path
        description: 'Id of the conversation.

          '
      body:
        type: json
        data: '{}'
    docs: Adds note to an existing conversation.
  - info:
      name: Get Note
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/conversations/:conversationId/notes/:noteId
      params:
      - name: conversationId
        value: ''
        type: path
        description: 'id of the conversation

          '
      - name: noteId
        value: ''
        type: path
        description: 'id of the note

          '
    docs: 'Returns the note with the provided conversation and note id.

      '
  - info:
      name: Reply to Message
      type: http
    http:
      method: POST
      url: https://{organization}.gladly.com/api/v1/api/v1/conversation-items/:itemId/reply
      params:
      - name: itemId
        value: ''
        type: path
        description: 'id of the conversation item

          '
      body:
        type: json
        data: '{}'
    docs: Sends a response to a conversation item. If no agent is assigned to the conversation, the conversation is assigned
      to the API User who made this call.
  - info:
      name: Redact Conversation Item
      type: http
    http:
      method: POST
      url: https://{organization}.gladly.com/api/v1/api/v1/conversation-items/:itemId/redact
      params:
      - name: itemId
        value: ''
        type: path
        description: 'id of the conversation item

          '
      body:
        type: json
        data: '{}'
    docs: 'For supported items, the item''s content will be removed but the item will

      remain in the conversation timeline. Supported types are Chat Message,

      SMS Message, Email, Twitter (decommissioned as of 04/20/23, but can still be redacted), WhatsApp, Voicemail, Phone Call.

      '
- info:
    name: Tasks
    type: folder
  items:
  - info:
      name: Create Task
      type: http
    http:
      method: POST
      url: https://{organization}.gladly.com/api/v1/api/v1/tasks
      body:
        type: json
        data: '{}'
    docs: 'To add tasks to the timeline for a customer specified by identifying information. If the customer doesn''t exist,
      a new customer profile is created.

      '
  - info:
      name: List Tasks
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/customers/:customerId/tasks
      params:
      - name: customerId
        value: ''
        type: path
        description: 'Id of the customer whose tasks you''d like to view.

          '
      - name: status
        value: ''
        type: query
        description: 'Fetch tasks with the provided status.

          '
    docs: "Fetch all tasks for a customer.\n\nThe list is not paginated and will return at most 2000 tasks. The tasks are\
      \ returned in descending order by timestamp. \nThe `Gladly-Limited-Data` header flag in the response will indicate if\
      \ the customer has more tasks than returned.        \n\nTo see and act on any newly created tasks, webhooks can be used\
      \ to listen for task related events.\nTasks older than the limit can be viewed using the Task Export.\n"
  - info:
      name: Create Task for Customer
      type: http
    http:
      method: POST
      url: https://{organization}.gladly.com/api/v1/api/v1/customers/:customerId/tasks
      params:
      - name: customerId
        value: ''
        type: path
        description: 'Id of the customer associated with the task to create.


          You can look up the id using the [Find customers](index.html#tag/Customers) API.

          '
      body:
        type: json
        data: '{}'
    docs: 'Add a task to an existing customer''s conversation timeline

      '
  - info:
      name: Get Task
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/tasks/:taskId
      params:
      - name: taskId
        value: ''
        type: path
        description: 'Id of the task requested

          '
    docs: 'Get task

      '
  - info:
      name: Update Task
      type: http
    http:
      method: PATCH
      url: https://{organization}.gladly.com/api/v1/api/v1/tasks/:taskId
      params:
      - name: taskId
        value: ''
        type: path
        description: 'Id of the task that is to be updated

          '
      body:
        type: json
        data: '{}'
    docs: 'Update an existing task

      '
  - info:
      name: Get Task Comments
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/tasks/:taskId/comments
      params:
      - name: taskId
        value: ''
        type: path
        description: 'Id of the task comments are requested for.

          '
    docs: 'The comments are returned in ascending order by createdAt timestamp. The list is not paginated and will return
      at most 1000 task comments. The `Gladly-Limited-Data` header flag in the response will indicate if the task has more
      comments than returned.


      To see and act on any newly created task comments, webhooks can be used to listen to any task comment related events.

      '
  - info:
      name: Add Task Comment
      type: http
    http:
      method: POST
      url: https://{organization}.gladly.com/api/v1/api/v1/tasks/:taskId/comments
      params:
      - name: taskId
        value: ''
        type: path
        description: 'Id of the task that will be commented on.

          '
      body:
        type: json
        data: '{}'
    docs: 'Create a comment on a task.  Note that you can’t create comments on closed tasks.

      ![Task Comment](assets/task-comment.png)

      '
  - info:
      name: Get Task Comment
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/tasks/:taskId/comments/:commentId
      params:
      - name: taskId
        value: ''
        type: path
        description: 'Task id

          '
      - name: commentId
        value: ''
        type: path
        description: 'Comment id

          '
    docs: 'Get task comment.

      '
- info:
    name: Freeform Topics
    type: folder
  items:
  - info:
      name: Get Custom Attribute
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/custom-attributes/:customAttributeId
      params:
      - name: customAttributeId
        value: ''
        type: path
        description: 'id of the custom attribute

          '
    docs: 'Returns a custom attribute that matches the provided custom attribute id.

      '
- info:
    name: Customers
    type: folder
  items:
  - info:
      name: Find Customers
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/customer-profiles
      params:
      - name: email
        value: ''
        type: query
        description: customer email address to search on.
      - name: externalCustomerId
        value: ''
        type: query
        description: Customer ID in your system of record for Customer Profiles linked to a Lookup Adaptor installed prior
          to 05/12/21. If Customer Profile is linked to a Lookup Adaptor installed on or after 05/12/21, this field is not
          searchable.
      - name: phoneNumber
        value: ''
        type: query
        description: 'Phone number in E.164 format. The value should be URL escaped where `+` becomes `%2B`.

          '
    docs: "Find customers by searching by choosing **one** of the following identifiers as query parameters:\n\n```\n/api/v1/customer-profiles?phoneNumber=%2B14151234567\n\
      ```\n\nMax limit of 50 profiles returned, sorted by most recently updatedAt date descending. \n"
  - info:
      name: Create Customer
      type: http
    http:
      method: POST
      url: https://{organization}.gladly.com/api/v1/api/v1/customer-profiles
      body:
        type: json
        data: '{}'
    docs: 'Create a new customer with the supplied profile data.

      '
  - info:
      name: Get Customer
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/customer-profiles/:customerId
      params:
      - name: customerId
        value: ''
        type: path
        description: id of the customer
    docs: 'Get a customer by unique id.

      If a customer has been merged into another, an error will be returned specifying the new id of the customer.

      '
  - info:
      name: Update Customer
      type: http
    http:
      method: PATCH
      url: https://{organization}.gladly.com/api/v1/api/v1/customer-profiles/:customerId
      params:
      - name: customerId
        value: ''
        type: path
        description: id of the customer
      body:
        type: json
        data: '{}'
    docs: 'Update a customer by unique id with the supplied JSON patch.


      You may supply only the properties which you want to update or insert into the profile.

      When updating arrays, such as `phones` and `emails` you must provide the entire list of values

      since it is not possible to add or delete a single value.


      If a customer has been merged into another, an error will be returned specifying the new id of the customer.

      '
  - info:
      name: Delete Customer
      type: http
    http:
      method: DELETE
      url: https://{organization}.gladly.com/api/v1/api/v1/customer-profiles/:customerId
      params:
      - name: customerId
        value: ''
        type: path
        description: id of the customer
    docs: 'Delete a customer and all associated conversations.


      All conversations associated with the customer must be closed before the customer can be deleted.


      This operation is irreversible.


      The user associated with the API token must have both Compliance Admin and API User roles.

      '
- info:
    name: User Identity
    type: folder
  items:
  - info:
      name: Create a User Identity JWT
      type: http
    http:
      method: POST
      url: https://{organization}.gladly.com/api/v1/api/v1/user-identity-jwt
      body:
        type: json
        data: '{}'
    docs: "Create a User Identity JWT for a customer. The JWT is used to authenticate the customer with \n[Chat](https://developer.gladly.com/chat/).\
      \ The JWT contains the customer identity information.\n"
- info:
    name: Public Answer
    type: folder
  items:
  - info:
      name: Search Public Answers
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/orgs/:orgId/answers-search?q=search+terms
      params:
      - name: orgId
        value: ''
        type: path
        description: 'id of your organization


          You can look up the ID using the [Get organization](index.html#tag/Organization) API.

          '
      - name: q
        value: ''
        type: query
        description: search term
      - name: lng
        value: ''
        type: query
        description: language code
      - name: audienceId
        value: ''
        type: query
        description: Audience ID. The Audience ID can be retrieved by going to Settings > Audiences in Gladly, then clicking
          on the Edit button next to the Audience in question. The ID will be in the page URL.
    docs: 'Returns a list of answers that match the provided query string.

      '
  - info:
      name: List Public Answers
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/orgs/:orgId/answers?lng=:lng&audienceId=:audienceId
      params:
      - name: orgId
        value: ''
        type: path
        description: 'id of your organization


          You can look up the ID using the [Get organization](index.html#tag/Organization) API.

          '
      - name: lng
        value: ''
        type: query
        description: 'Language of the answers returned


          Defaults to `en-us`

          '
      - name: audienceId
        value: ''
        type: query
        description: 'Audience ID for answers returned - optional. The Audience ID can be retrieved by going to Settings >
          Audiences in Gladly, then clicking on the Edit button next to the Audience in question. The ID will be in the page
          URL.

          '
    docs: 'Returns the first 1000 public answers sorted alphabetically by name.

      '
  - info:
      name: List Help Center Answer Titles
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/orgs/:orgId/help-center/:helpCenterId/answer-titles?lng=:lng&audienceId=:audienceId
      params:
      - name: orgId
        value: ''
        type: path
        description: 'id of your organization


          You can look up the ID using the [Get organization](index.html#tag/Organization) API.

          '
      - name: helpCenterId
        value: ''
        type: path
        description: 'Help Center ID


          You can look up the ID by going to Settings > Help Center in Gladly, then clicking on the 3 dots next to the Help
          Center and selecting Configure. Help Center ID will be in the URL

          '
      - name: lng
        value: ''
        type: query
        description: 'Language of the answers returned


          Defaults to `en-us`

          '
      - name: audienceId
        value: ''
        type: query
        description: 'Audience ID for answers returned - optional. The Audience ID can be retrieved by going to Settings >
          Audiences in Gladly, then clicking on the Edit button next to the Audience in question. The ID will be in the page
          URL.

          '
    docs: 'Returns an array of answers configured in Help Center sections with their ID and name

      '
  - info:
      name: Get Public Answer
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/orgs/:orgId/answers/:answerId
      params:
      - name: orgId
        value: ''
        type: path
        description: 'id of your organization


          You can look up the ID using the [Get organization](index.html#tag/Organization) API.

          '
      - name: answerId
        value: ''
        type: path
        description: id of the answer
      - name: lng
        value: ''
        type: query
        description: language code
    docs: 'Returns the answer with the provided id.

      '
- info:
    name: Answer Management
    type: folder
  items:
  - info:
      name: Add Answer
      type: http
    http:
      method: POST
      url: https://{organization}.gladly.com/api/v1/api/v1/answers
      body:
        type: json
        data: '{}'
    docs: 'Adds an answer to the list of answers.

      '
  - info:
      name: Get Answer
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/answers/:answerId
      params:
      - name: answerId
        value: ''
        type: path
        description: id of the answer
    docs: 'Returns the answer requested.

      '
  - info:
      name: Update Answer
      type: http
    http:
      method: PATCH
      url: https://{organization}.gladly.com/api/v1/api/v1/answers/:answerId
      params:
      - name: answerId
        value: ''
        type: path
        description: id of the answer
      body:
        type: json
        data: '{}'
    docs: 'Updates the answer with the provided id.

      '
  - info:
      name: Delete Answer
      type: http
    http:
      method: DELETE
      url: https://{organization}.gladly.com/api/v1/api/v1/answers/:answerId
      params:
      - name: answerId
        value: ''
        type: path
        description: id of the answer
    docs: 'Deletes the answer with the provided id.

      '
  - info:
      name: Get Answer Content
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/answers/:answerId/languages/:language/type/:type
      params:
      - name: answerId
        value: ''
        type: path
        description: id of the answer
      - name: language
        value: ''
        type: path
        description: Language code according to ISO 639 format. The specified language must also be configured for the org.
      - name: type
        value: ''
        type: path
        description: Type of answer. Must be one of `public`, `email`, `messaging`, or `reference`.
    docs: 'Returns the answer content requested by language and type.

      '
  - info:
      name: Add or Update Answer Content
      type: http
    http:
      method: PUT
      url: https://{organization}.gladly.com/api/v1/api/v1/answers/:answerId/languages/:language/type/:type
      params:
      - name: answerId
        value: ''
        type: path
        description: id of the answer
      - name: language
        value: ''
        type: path
        description: Language code according to ISO 639 format. The specified language must also be configured for the org.
      - name: type
        value: ''
        type: path
        description: Type of answer. Must be one of `public`, `email`, `messaging`, or `reference`.
      body:
        type: json
        data: '{}'
    docs: 'Adds or Updates the answer content for the specified answer by language and type.

      '
  - info:
      name: Delete Answer Content
      type: http
    http:
      method: DELETE
      url: https://{organization}.gladly.com/api/v1/api/v1/answers/:answerId/languages/:language/type/:type
      params:
      - name: answerId
        value: ''
        type: path
        description: id of the answer
      - name: language
        value: ''
        type: path
        description: Language code according to ISO 639 format. The specified language must also be configured for the org.
      - name: type
        value: ''
        type: path
        description: Type of answer. Must be one of `public`, `email`, `messaging`, or `reference`.
    docs: 'Deletes the answer content for the specified answer by language and type.

      '
- info:
    name: Agents
    type: folder
  items:
  - info:
      name: List Agents
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/agents
    docs: 'Returns a list of agents.

      '
  - info:
      name: Get Agent
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/agents/:agentId
      params:
      - name: agentId
        value: ''
        type: path
        description: id of the agent
    docs: 'Get an agent profile by their unique id.

      '
  - info:
      name: Get Agent CallRecorder
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/agents/:agentId/call-recorder
      params:
      - name: agentId
        value: ''
        type: path
        description: Gladly ID or Gladly email address of the agent
    docs: 'Get an agent call recording status.

      '
  - info:
      name: Update Agent CallRecorder
      type: http
    http:
      method: PATCH
      url: https://{organization}.gladly.com/api/v1/api/v1/agents/:agentId/call-recorder
      params:
      - name: agentId
        value: ''
        type: path
        description: Gladly ID or Gladly email address of the agent
      body:
        type: json
        data: '{}'
    docs: 'Update an agent''s active call recording status. This API allows changing the `recording` property.

      '
- info:
    name: Audiences
    type: folder
  items:
  - info:
      name: List Audiences
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/audiences
    docs: 'Returns a list of audiences.

      '
- info:
    name: Business Hours
    type: folder
  items:
  - info:
      name: List Business Hours
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/business-hours
    docs: 'Returns a list of all business hours configurations for your organization.

      '
  - info:
      name: Create Business Hours
      type: http
    http:
      method: POST
      url: https://{organization}.gladly.com/api/v1/api/v1/business-hours
      body:
        type: json
        data: '{}'
    docs: 'Creates a new business hours configuration for your organization.

      '
  - info:
      name: Get Business Hours
      type: http
    http:
      method: GET
      url: https://{organization}.gladly.com/api/v1/api/v1/business-hours/:businessHoursId
      params:
      - name: businessHoursId
        value: ''
        type: path
        description: ID of the business hours configuration
    docs: 'Returns a single business hours configuration by its unique ID.

      '
  - info:
      name: Update Business Hours
      type: http
    http:
      method: PUT
      url: https://{organization}.gladly.com/api/v1/api/v1/business-hours/:businessHoursId
      params:
      - name: businessHoursId
        value: ''
        type: path
        description: ID of the business hours configuration
      body:
        type: json
        data: '{}'
    docs: 'Updates an existing business hours configuration. The `version` field must match the current version of the business
      hours to prevent conflicting updates.

      '
  - info:
      name: Delete Business Hours
      type: http
    http:
      method: DELETE
      url: https://{organization}.gladly.com/api/v1/api/v1/business-hours/:businessHoursId
      params:
      - name: businessHoursId
        value: ''
        type: path
        description: ID of the business hours configuration
    docs: 'Deletes a business hours configuration. The primary business hours configuration cannot be deleted.

      '
- info:
    name: Organization
    type: folder
  items:
  - info:
      name: Get Organization
      type: http
    http:
      method: GET
      url: https://{o

# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gladly/refs/heads/main/apis.yml