Patch a campaign

PATCH

/api/v1/campaigns/{campaign_id}

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Patch,
    RequestUri = new Uri("https://external-api.moja-ai.com/api/v1/campaigns/example"),
    Headers =
    {
        { "X-API-Key", "<X-API-Key>" },
    },
    Content = new StringContent("{ \"name\": \"example\", \"routing_plan_id\": \"example\", \"call_flow_id\": \"example\", \"execution_mode\": \"routing_plan\", \"is_active\": true, \"payout\": 1, \"timezone\": \"America/New_York\", \"conversion_scope\": 1, \"qai_category_id\": 1, \"tcpa_scrubbing\": \"default\", \"tcpa_scrubbing_config\": { \"id\": \"example\", \"api_key\": \"example\", \"api_version\": \"v1\", \"api_url\": \"https://api.blacklistalliance.net/lookup?key=abc123&ver=v1&resp=raw&phone=\", \"allow_calls_on_failure\": true }, \"number_group_items\": [ { \"id\": \"example\", \"number_id\": \"example\", \"publisher_id\": \"example\", \"type\": \"static\", \"payout\": 1, \"payout_condition\": \"example\", \"payout_condition_duration\": 1, \"payout_percentage\": 1, \"external_id\": \"example\", \"is_active\": true } ], \"ivr_payout_rules\": [ { \"id\": \"example\", \"legacy_rule_id\": \"example\", \"combinator\": \"and\", \"payout\": 0, \"filters\": [ { \"field\": \"keypress\", \"operator\": \"equals\", \"value\": \"1\" } ] } ], \"outgoing_webhooks\": [ \"example\" ], \"incoming_webhooks\": [ \"example\" ], \"preconverted_caller\": true, \"preconverted_destination\": true, \"preconverted_publisher\": true, \"preconverted_campaign\": true, \"external_id\": \"example\", \"disable_recordings\": true, \"access_to_call_recordings\": true, \"expose_ineligible_routes\": true, \"ineligible_routes_fields\": \"example\", \"advanced_caps\": [ {} ] }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

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

func main() {

  url := "https://external-api.moja-ai.com/api/v1/campaigns/example"

  payload := strings.NewReader("{ \"name\": \"example\", \"routing_plan_id\": \"example\", \"call_flow_id\": \"example\", \"execution_mode\": \"routing_plan\", \"is_active\": true, \"payout\": 1, \"timezone\": \"America/New_York\", \"conversion_scope\": 1, \"qai_category_id\": 1, \"tcpa_scrubbing\": \"default\", \"tcpa_scrubbing_config\": { \"id\": \"example\", \"api_key\": \"example\", \"api_version\": \"v1\", \"api_url\": \"https://api.blacklistalliance.net/lookup?key=abc123&ver=v1&resp=raw&phone=\", \"allow_calls_on_failure\": true }, \"number_group_items\": [ { \"id\": \"example\", \"number_id\": \"example\", \"publisher_id\": \"example\", \"type\": \"static\", \"payout\": 1, \"payout_condition\": \"example\", \"payout_condition_duration\": 1, \"payout_percentage\": 1, \"external_id\": \"example\", \"is_active\": true } ], \"ivr_payout_rules\": [ { \"id\": \"example\", \"legacy_rule_id\": \"example\", \"combinator\": \"and\", \"payout\": 0, \"filters\": [ { \"field\": \"keypress\", \"operator\": \"equals\", \"value\": \"1\" } ] } ], \"outgoing_webhooks\": [ \"example\" ], \"incoming_webhooks\": [ \"example\" ], \"preconverted_caller\": true, \"preconverted_destination\": true, \"preconverted_publisher\": true, \"preconverted_campaign\": true, \"external_id\": \"example\", \"disable_recordings\": true, \"access_to_call_recordings\": true, \"expose_ineligible_routes\": true, \"ineligible_routes_fields\": \"example\", \"advanced_caps\": [ {} ] }")

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

  req.Header.Add("X-API-Key", "<X-API-Key>")
  req.Header.Add("Content-Type", "application/json")

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

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

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://external-api.moja-ai.com/api/v1/campaigns/example';
const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<X-API-Key>', 'Content-Type': 'application/json'},
  body: '{"name":"example","routing_plan_id":"example","call_flow_id":"example","execution_mode":"routing_plan","is_active":true,"payout":1,"timezone":"America/New_York","conversion_scope":1,"qai_category_id":1,"tcpa_scrubbing":"default","tcpa_scrubbing_config":{"id":"example","api_key":"example","api_version":"v1","api_url":"https://api.blacklistalliance.net/lookup?key=abc123&ver=v1&resp=raw&phone=","allow_calls_on_failure":true},"number_group_items":[{"id":"example","number_id":"example","publisher_id":"example","type":"static","payout":1,"payout_condition":"example","payout_condition_duration":1,"payout_percentage":1,"external_id":"example","is_active":true}],"ivr_payout_rules":[{"id":"example","legacy_rule_id":"example","combinator":"and","payout":0,"filters":[{"field":"keypress","operator":"equals","value":"1"}]}],"outgoing_webhooks":["example"],"incoming_webhooks":["example"],"preconverted_caller":true,"preconverted_destination":true,"preconverted_publisher":true,"preconverted_campaign":true,"external_id":"example","disable_recordings":true,"access_to_call_recordings":true,"expose_ineligible_routes":true,"ineligible_routes_fields":"example","advanced_caps":[{}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://external-api.moja-ai.com/api/v1/campaigns/example \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "name": "example", "routing_plan_id": "example", "call_flow_id": "example", "execution_mode": "routing_plan", "is_active": true, "payout": 1, "timezone": "America/New_York", "conversion_scope": 1, "qai_category_id": 1, "tcpa_scrubbing": "default", "tcpa_scrubbing_config": { "id": "example", "api_key": "example", "api_version": "v1", "api_url": "https://api.blacklistalliance.net/lookup?key=abc123&ver=v1&resp=raw&phone=", "allow_calls_on_failure": true }, "number_group_items": [ { "id": "example", "number_id": "example", "publisher_id": "example", "type": "static", "payout": 1, "payout_condition": "example", "payout_condition_duration": 1, "payout_percentage": 1, "external_id": "example", "is_active": true } ], "ivr_payout_rules": [ { "id": "example", "legacy_rule_id": "example", "combinator": "and", "payout": 0, "filters": [ { "field": "keypress", "operator": "equals", "value": "1" } ] } ], "outgoing_webhooks": [ "example" ], "incoming_webhooks": [ "example" ], "preconverted_caller": true, "preconverted_destination": true, "preconverted_publisher": true, "preconverted_campaign": true, "external_id": "example", "disable_recordings": true, "access_to_call_recordings": true, "expose_ineligible_routes": true, "ineligible_routes_fields": "example", "advanced_caps": [ {} ] }'

Authorizations

MojaApiKeyHeader
MojaApiBearer

Parameters

Path Parameters

campaign_id

required

Campaign Id

string

Header Parameters

X-API-Key

Any of:

string
null

string

Request Body^required

application/json

CampaignPatch

object

name

Any of:

string
null

string

>= 1 characters <= 255 characters

routing_plan_id

Any of:

string
null

string

call_flow_id

Any of:

string
null

string

execution_mode

Any of:

string
null

string

Allowed values: routing_plan call_flow

is_active

Any of:

boolean
null

boolean

payout

Any of:

number
null

number

timezone

Any of:

string
null

string

conversion_scope

Any of:

integer
null

integer

qai_category_id

Any of:

integer
null

integer

tcpa_scrubbing

Any of:

string
null

string

Allowed values: default blacklist-alliance

tcpa_scrubbing_config

Any of:

CampaignTCPAScrubbingConfig
null

CampaignTCPAScrubbingConfig

id is the DB row uuid (campaign_tcpa_scrubbing_configs.uuid) for stable PATCH round-trips.

object

Any of:

string
null

string

>= 1 characters <= 36 characters

api_key

Any of:

string
null

string

<= 255 characters

api_version

Any of:

string
null

string

Allowed values: v1 v2 v3

api_url

Any of:

string
null

string

allow_calls_on_failure

Allow Calls On Failure

boolean

default: true

number_group_items

Any of:

Array<object>
null

Array<object>

CampaignNumberGroupItemWrite

Writable number-group fields. Pause is managed via /entity_pause/campaign_numbers.

object

Any of:

string
null

string

>= 1 characters <= 36 characters

number_id

required

Number Id

string

publisher_id

Any of:

string
null

string

type

Type

string

default: static

Allowed values: static dynamic

payout

Any of:

number
null

number

payout_condition

Any of:

string
null

string

payout_condition_duration

Any of:

integer
null

integer

payout_percentage

Any of:

number
null

number

external_id

Any of:

string
null

string

>= 1 characters <= 64 characters

is_active

Is Active

boolean

default: true

ivr_payout_rules

Any of:

Array<object>
null

Array<object>

CampaignIVRPayoutRule

id is campaign_ivr_payout_rules.uuid; legacy_rule_id is the legacy JSON rule key when distinct.

object

Any of:

string
null

string

>= 1 characters <= 36 characters

legacy_rule_id

Any of:

string
null

string

combinator

Combinator

string

default: and

Allowed values: and or

payout

Payout

number

filters

Filters

Array<object>

object

key

additional properties

any

outgoing_webhooks

Any of:

Array<string>
null

Array<string>

incoming_webhooks

Any of:

Array<string>
null

Array<string>

preconverted_caller

Any of:

boolean
null

boolean

preconverted_destination

Any of:

boolean
null

boolean

preconverted_publisher

Any of:

boolean
null

boolean

preconverted_campaign

Any of:

boolean
null

boolean

external_id

Any of:

string
null

string

>= 1 characters <= 64 characters

disable_recordings

Any of:

boolean
null

boolean

access_to_call_recordings

Any of:

boolean
null

boolean

expose_ineligible_routes

Any of:

boolean
null

boolean

ineligible_routes_fields

Any of:

string
null

string

advanced_caps

Any of:

Array<object>
null

Array<object>

object

key

additional properties

any

Responses

200

Successful Response

application/json

CampaignResponse

object

required

string

created_at

Any of:

string
null

string format: date-time

updated_at

Any of:

string
null

string format: date-time

name

required

Name

string

org_id

required

Org Id

string

routing_plan_id

Any of:

string
null

string

call_flow_id

Any of:

string
null

string

execution_mode

required

Execution Mode

string

is_active

required

Is Active

boolean

payout

Any of:

number
null

number

timezone

Any of:

string
null

string

conversion_scope

required

Conversion Scope

integer

qai_category_id

Any of:

integer
null

integer

tcpa_scrubbing

Any of:

string
null

string

tcpa_scrubbing_config

Any of:

CampaignTCPAScrubbingConfig
null

CampaignTCPAScrubbingConfig

id is the DB row uuid (campaign_tcpa_scrubbing_configs.uuid) for stable PATCH round-trips.

object

Any of:

string
null

string

>= 1 characters <= 36 characters

api_key

Any of:

string
null

string

<= 255 characters

api_version

Any of:

string
null

string

Allowed values: v1 v2 v3

api_url

Any of:

string
null

string

allow_calls_on_failure

Allow Calls On Failure

boolean

default: true

number_group_items

Number Group Items

Array<object>

CampaignNumberGroupItem

id is campaign_number_group_items.uuid (stable row id). Includes pause state on reads.

object

Any of:

string
null

string

>= 1 characters <= 36 characters

number_id

required

Number Id

string

publisher_id

Any of:

string
null

string

type

Type

string

default: static

Allowed values: static dynamic

payout

Any of:

number
null

number

payout_condition

Any of:

string
null

string

payout_condition_duration

Any of:

integer
null

integer

payout_percentage

Any of:

number
null

number

external_id

Any of:

string
null

string

>= 1 characters <= 64 characters

is_active

Is Active

boolean

default: true

number

Any of:

string
null

string

publisher_name

Any of:

string
null

string

paused_until

Any of:

string
null

string format: date-time

paused_at

Any of:

string
null

string format: date-time

paused_by

Any of:

string
null

string

is_paused

Is Paused

boolean

ivr_payout_rules

Ivr Payout Rules

Array<object>

CampaignIVRPayoutRule

id is campaign_ivr_payout_rules.uuid; legacy_rule_id is the legacy JSON rule key when distinct.

object

Any of:

string
null

string

>= 1 characters <= 36 characters

legacy_rule_id

Any of:

string
null

string

combinator

Combinator

string

default: and

Allowed values: and or

payout

Payout

number

filters

Filters

Array<object>

object

key

additional properties

any

outgoing_webhooks

Outgoing Webhooks

Array<string>

incoming_webhooks

Incoming Webhooks

Array<string>

preconverted_caller

Preconverted Caller

boolean

preconverted_destination

Preconverted Destination

boolean

preconverted_publisher

Preconverted Publisher

boolean

preconverted_campaign

Preconverted Campaign

boolean

external_id

Any of:

string
null

string

disable_recordings

Disable Recordings

boolean

access_to_call_recordings

required

Access To Call Recordings

boolean

expose_ineligible_routes

Expose Ineligible Routes

boolean

ineligible_routes_fields

Any of:

string
null

string

routing_plan

Any of:

ResourceRef
null

ResourceRef

object

required

string

name

Any of:

string
null

string

advanced_caps

Advanced Caps

Array<object>

object

key

additional properties

any

Example

{
  "tcpa_scrubbing_config": {
    "api_version": "v1",
    "api_url": "https://api.blacklistalliance.net/lookup?key=abc123&ver=v1&resp=raw&phone=",
    "allow_calls_on_failure": true
  },
  "number_group_items": [
    {
      "type": "static",
      "is_active": true,
      "is_paused": false
    }
  ],
  "ivr_payout_rules": [
    {
      "combinator": "and",
      "payout": 0,
      "filters": [
        {
          "field": "keypress",
          "operator": "equals",
          "value": "1"
        }
      ]
    }
  ],
  "preconverted_caller": false,
  "preconverted_destination": false,
  "preconverted_publisher": false,
  "preconverted_campaign": false,
  "disable_recordings": false,
  "expose_ineligible_routes": false
}

400

Bad Request

application/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

401

Unauthorized

application/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

404

Not Found

application/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

409

Conflict

application/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

422

Validation Error

application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}

429

Too Many Requests

application/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

Patch a campaign

Authorizations

Parameters

Path Parameters

Header Parameters

Request Bodyrequired

Responses

200

Example

400

Examplegenerated

401

Examplegenerated

404

Examplegenerated

409

Examplegenerated

422

Examplegenerated

429

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated