Service

Update service configuration

Updates configuration specific to the type of automated service.

Only certain types of services support updating their configuration via the API.

Note: when updating a service of type custom_template_instance, the validation script will be invoked when calling this method.

Request Schema: The config object structure depends on the service's service_type. See x-service-types in the API info section for required fields per service type.

post/v1/projects/{project_id}/services/{id}/config

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/services/{id}/config
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://telerivet.com/oauth/authorize, token URL https://api.telerivet.com/oauth/token)

Path parameters

project_idstring required

ID of the Project

idstring required

ID of the Service

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "actions": [
    {
      "type": "reply",
      "body": {
        "content": "Hello, [[contact.name]]."
      }
    }
  ],
  "subroutines": [
    {
      "actions": [
        {
          "type": "add_contact_to_group",
          "group_name": "subscribers"
        }
      ]
    }
  ],
  "response_handlers": [
    {
      "actions": [
        {
          "type": "reply",
          "body": {
            "content": "Hello, [[contact.name]]."
          }
        }
      ]
    }
  ]
}

Response

Updated service configuration

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example response

{
  "actions": [
    {
      "type": "reply",
      "body": {
        "content": "Hello, [[contact.name]]."
      }
    }
  ],
  "subroutines": [
    {
      "actions": [
        {
          "type": "add_contact_to_group",
          "group_name": "subscribers"
        }
      ]
    }
  ],
  "response_handlers": [
    {
      "actions": [
        {
          "type": "reply",
          "body": {
            "content": "Hello, [[contact.name]]."
          }
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.