PUT/api/v1/contract-lines/{id}/activation

Set contract line activation

Activates or deactivates a contract line. Deactivation can require a reason when plan is in use.

Path parameters

idstring <uuid>Required

Contract line UUID from contract_lines.contract_line_id.

Request body

Content type: application/json · schema ContractLineActivationBody

is_activebooleanRequired

effective_datestring <date-time>

reasonstring

notify_clientsboolean

Response body

Success response 200 · schema ContractLineApiSuccess

successbooleanRequired

Enum: true

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

timestampstring <date-time>Required

versionstringRequired

Response codes

200

Activation state updated.

400

Invalid request payload.

401

x-api-key missing at middleware.

500

Request context missing or activation business-rule failure.

PUT /api/v1/contract-lines/{id}/activation

cURL

curl -X PUT "https://algapsa.com/api/v1/contract-lines/{id}/activation" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "is_active": false,
  "effective_date": "2026-04-18T15:22:14Z",
  "reason": "string",
  "notify_clients": false
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/contract-lines/{id}/activation", {
  method: "PUT",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "is_active": false,
    "effective_date": "2026-04-18T15:22:14Z",
    "reason": "string",
    "notify_clients": false
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Put, "https://algapsa.com/api/v1/contract-lines/{id}/activation");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""is_active"": false,
  ""effective_date"": ""2026-04-18T15:22:14Z"",
  ""reason"": ""string"",
  ""notify_clients"": false
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "success": true,
  "data": {},
  "meta": {
    "timestamp": "2026-04-18T15:22:14Z",
    "version": "string"
  }
}