Archive

API Reference

V1

Customers

Archive a customer

client.V1.Customers.Archive(ctx, body) (*DataIDV1CustomerArchiveResponse, error)

post/v1/customers/archive

Archive a customer Note: any alerts associated with the customer will not be triggered.

Parameters

bodyIDfieldV1CustomerArchiveParams

Hide ParametersShow Parameters

IDfield

param.Field[IDstringID]

Returns

V1CustomerArchiveResponsestruct

Hide ParametersShow Parameters

DataIDstringID

HTTPTypeScriptPythonGoRubyTerraform

package main

import (
  "context"
  "fmt"

  "github.com/Metronome-Industries/metronome-go"
  "github.com/Metronome-Industries/metronome-go/option"
  "github.com/Metronome-Industries/metronome-go/shared"
)

func main() {
  client := metronome.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  response, err := client.V1.Customers.Archive(context.TODO(), metronome.V1CustomerArchiveParams{
    ID: shared.IDParam{

    },
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Data)
}

200 Example

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}