Agents

Update a certain agent.

Update an agent (formerly known as project) with specific details based on its unique projectId. This endpoint allows you to modify and revise the information associated with a particular agent Here is an example to a update a specific object: API SDK.

post/api/v1/projects/{projectId}

Path parameters

projectIdinteger required

The unique identifier of the agent (formerly known as project).

Response

Agent has been updated

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "id": 1,
    "project_name": "My Agent",
    "sitemap_path": "https://www.example.com/sitemap.xml",
    "is_chat_active": true,
    "user_id": 1,
    "team_id": 1,
    "created_at": "2021-01-01 00:00:00",
    "updated_at": "2021-01-01 00:00:00",
    "deleted_at": "2021-01-01 00:00:00",
    "type": "SITEMAP",
    "is_shared": true,
    "shareable_slug": "1234567890abcdef1234567890abcdef",
    "are_licenses_allowed": true
  }
}

Changes

Changed in 5 of the 9 revisions of this API.22233

  • b80e6dfcf78d210See the full diff
    • added the new Agent id is required enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new Agent with id {projectId} not found enum value to the / response property for the response status

      response-property-enum-value-added

    • api tag Agents added

      api-tag-added

    • api tag Projects removed

      api-tag-removed

    • added the new optional request property

      new-optional-request-property

    • added the new optional request property

      new-optional-request-property

    • added the new optional request property

      new-optional-request-property

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • removed the Project id is required enum value from the / response property for the response status

      response-property-enum-value-removed

    • removed the Project with id {projectId} not found enum value from the / response property for the response status

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the non-success response with the status

      response-non-success-status-added

  • 1675fc6aa16a114See the full diff
    • removed the optional property / from the response with the status

      response-optional-property-removed

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

  • 754bec1d3aae11See the full diff
    • removed the media type application/json from the request body

      request-body-media-type-removed

    • added the media type multipart/form-data to the request body

      request-body-media-type-added

  • 1842d7fd04301197See the full diff
    • removed the media type multipart/form-data from the request body

      request-body-media-type-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • added the new Project id is required enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new Project with id {projectId} not found enum value to the / response property for the response status

      response-property-enum-value-added

    • api tag Projects added

      api-tag-added

    • api tag Agents removed

      api-tag-removed

    • added the media type application/json to the request body

      request-body-media-type-added

    • removed the non-success response with the status

      response-non-success-status-removed

    • added the optional property / to the response with the status

      response-optional-property-added

    • removed the Agent id is required enum value from the / response property for the response status

      response-property-enum-value-removed

    • removed the Agent with id {projectId} not found enum value from the / response property for the response status

      response-property-enum-value-removed

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog