Post v1integrations activate

POST /v1/integrations/{integration}/activate

cURL

cURL

curl --request POST \
  --url https://api.comm.com/api/v1/integrations/{integration}/activate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    {
      "type": "<string>",
      "is_active": true
    }
  ],
  "required_fields": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ]
}
'

import requests

url = "https://api.comm.com/api/v1/integrations/{integration}/activate"

payload = {
    "events": [
        {
            "type": "<string>",
            "is_active": True
        }
    ],
    "required_fields": [
        {
            "name": "<string>",
            "value": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    events: [{type: '<string>', is_active: true}],
    required_fields: [{name: '<string>', value: '<string>'}]
  })
};

fetch('https://api.comm.com/api/v1/integrations/{integration}/activate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.comm.com/api/v1/integrations/{integration}/activate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'events' => [
        [
                'type' => '<string>',
                'is_active' => true
        ]
    ],
    'required_fields' => [
        [
                'name' => '<string>',
                'value' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.comm.com/api/v1/integrations/{integration}/activate"

	payload := strings.NewReader("{\n  \"events\": [\n    {\n      \"type\": \"<string>\",\n      \"is_active\": true\n    }\n  ],\n  \"required_fields\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.comm.com/api/v1/integrations/{integration}/activate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"events\": [\n    {\n      \"type\": \"<string>\",\n      \"is_active\": true\n    }\n  ],\n  \"required_fields\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.comm.com/api/v1/integrations/{integration}/activate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"events\": [\n    {\n      \"type\": \"<string>\",\n      \"is_active\": true\n    }\n  ],\n  \"required_fields\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "message": "Integration activated"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

integration · string<uuid> · required

The integration ID

Body

application/json

IntegrationTeamMetaDataRequest

events · object[] | null

Show child attributes

required_fields · object[] | null

Show child attributes

Response

200

application/json

success · boolean · required

message · string · required

Example:

"Integration activated"