Solution

Create a solution

Creates a new solution, which is a named group of related services, data tables, contact groups, campaigns, message templates, and dashboards that together implement a particular use case.

After creating the solution, pass its ID as the solution_id parameter when creating (or updating) each service, data table, group, campaign, message template, or dashboard that is part of the solution.

post/v1/projects/{project_id}/solutions

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/solutions
  • 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

Request body

namestring required

Name of the solution, which must be unique within the project

descriptionstring

Description of the solution, e.g. what it does and how it is configured

skillbook_slugstring

Slug of the Skillbook solution template that this solution is an instance of, if applicable (from the skillbook_search or skillbook_get MCP tools)

varsobject

Custom variables and values to set for this solution. Variable names may be up to 32 characters in length and can contain the characters a-z, A-Z, 0-9, and _. Values may be strings, numbers, or boolean (true/false). String values may be up to 4096 bytes in length when encoded as UTF-8. Up to 100 variables are supported per object. Setting a variable to null will delete the variable.

Example request

{
  "name": "Text to Win",
  "description": "Customers text WIN to enter the monthly prize draw.",
  "skillbook_slug": "sol-text-to-win"
}

Response

Successful response

idstring

ID of the solution

namestring

Name of the solution, which must be unique within the project

descriptionstring nullable

Description of the solution

skillbook_slugstring nullable

Slug of the Skillbook solution template that this solution is an instance of, if applicable

truncatedstring[]

List of member types (services, tables, groups, campaigns, message_templates, dashboards) for which the solution has more members than are included in this response (more than 50). To list all members of a type, query that type with the solution_id filter (e.g. project.queryServices). Only returned when retrieving a single solution by ID.

varsobject

Custom variables stored for this solution. Variable names may be up to 32 characters in length and can contain the characters a-z, A-Z, 0-9, and _. Values may be strings, numbers, or boolean (true/false). String values may be up to 4096 bytes in length when encoded as UTF-8. Up to 100 variables are supported per object. Setting a variable to null will delete the variable.

time_createdinteger

Time the solution was created in Telerivet

time_updatedinteger

Time the solution was last updated in Telerivet

project_idstring

ID of the project this solution belongs to

Example response

{
  "id": "SO2ad0100821a98bea",
  "name": "Text to Win",
  "description": "Customers text WIN to enter the monthly prize draw.",
  "skillbook_slug": "sol-text-to-win",
  "time_created": 1392254503,
  "time_updated": 1392254503,
  "project_id": "PJ2ad0100821a98bea"
}

Changes

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