Skip to content

Archive a plan

Request

This endpoint allows you to archive a specific plan identified by its planId. Archiving a plan may be necessary for managing your plans effectively, especially when they are no longer active or needed.

Security
ApiKeyAuth
Path
planIdstringrequired
POST
/v3/plans/{planId}/archive
curl -i -X POST \
  'https://api.tellisim.com/v3/plans/{planId}/archive?key=YOUR_API_KEY_HERE'

Responses

Plan archived successfully

Bodyapplication/json
errorbooleanrequired

Indicates whether there was an error processing the request

Example:false
messagestringrequired

A message providing additional information about the request status

Example:"Plan archived successfully"
Response
{
  "error": false,
  "message": "Plan archived successfully"
}