Requeue or skip a campaign contact

PATCH

/campaigns/{id}/contacts/{contact_id}

import { createClient, createResources } from "@morevoice/sdk";

const mv = createResources({
  client: createClient({ baseUrl: "https://api.morevoice.ai/v1", auth: process.env.MOREVOICE_API_KEY }),
});

const campaignContact = await mv.campaigns.contacts.update("cmp_ojFwMD7YNTROjaTP0i3ZFb", "ctc_NKhjnYPvBUr2gmEgqwqw5N", {
  status: "skipped",
});
console.log(campaignContact);

import os

import requests

response = requests.patch(
    "https://api.morevoice.ai/v1/campaigns/cmp_ojFwMD7YNTROjaTP0i3ZFb/contacts/ctc_NKhjnYPvBUr2gmEgqwqw5N",
    headers={"Authorization": f"Bearer {os.environ['MOREVOICE_API_KEY']}"},
    json={
        "status": "skipped",
    },
)
response.raise_for_status()
print(response.json())

curl -X PATCH https://api.morevoice.ai/v1/campaigns/cmp_ojFwMD7YNTROjaTP0i3ZFb/contacts/ctc_NKhjnYPvBUr2gmEgqwqw5N \
  -H "Authorization: Bearer $MOREVOICE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "skipped"
}'

Status scheduled dials the contact again now (refused for a number on the do-not-call list); skipped takes it out of the campaign. A contact being dialled can’t change.

Try it in the API playground with a test-mode key.

Authorizations

bearerAuth

Parameters

Path Parameters

required

string

<= 200 characters /^cmp_[0-9A-Za-z]+$/

A campaign ID (cmp_…).

contact_id

required

string

<= 200 characters /^ctc_[0-9A-Za-z]+$/

A contact ID (ctc_…).

Header Parameters

MoreVoice-Version

string

/^\d{4}-\d{2}-\d{2}$/

The API version to use for this request. Defaults to the version the API key is pinned to.

Example

2026-11-01

Request Body^required

application/json

Requeue or skip a contact, like the dashboard’s contact actions.

object

status

required

Scheduled: dial it again now (refused for a do-not-call number); skipped: take it out of the campaign.

string

Allowed values: scheduled skipped

Responses

200

application/json

A contact in a campaign, with its dialling state and result.

object

attempts

required

integer

>= -9007199254740991 <= 9007199254740991

campaign_id

required

A campaign ID (prefix cmp_).

string

/^cmp_[0-9A-Za-z]+$/

completed_at

required

Any of:

string
null

An ISO-8601 timestamp in UTC.

string format: date-time

consent

required

The import said the person consented. Marketing calls also need a consent record with evidence (§30A).

boolean

created_at

required

An ISO-8601 timestamp in UTC.

string format: date-time

required

A contact ID (prefix ctc_).

string

/^ctc_[0-9A-Za-z]+$/

last_attempt_at

required

Any of:

string
null

An ISO-8601 timestamp in UTC.

string format: date-time

last_call_id

required

Any of:

string
null

A call ID (prefix call_).

string

/^call_[0-9A-Za-z]+$/

last_result

required

The last attempt’s result (answered, no_answer, busy, voicemail, …).

string | null

livemode

required

true in live mode, false in test mode.

boolean

name

required

string

next_attempt_at

required

Any of:

string
null

An ISO-8601 timestamp in UTC.

string format: date-time

object

required

string

Allowed value: campaign_contact

outcome

required

The disposition the assistant recorded.

string | null

outcome_data

required

Any of:

object
null

object

key

additional properties

phone

required

E.164.

string

row

required

Any of:

integer
null

integer

>= -9007199254740991 <= 9007199254740991

skip_reason

required

Why it is not dialled: dnc_import, dnc_dial_time, registry, no_consent, no_consent_evidence, no_calling_window, manual, …

string | null

status

required

Pending → dialing → scheduled | callback → … → done | failed; skipped, dnc, invalid and cancelled are never dialled.

string

Allowed values: pending scheduled callback dialing done failed dnc skipped invalid cancelled

timezone

required

string | null

updated_at

required

An ISO-8601 timestamp in UTC.

string format: date-time

variables

required

object

key

additional properties

string

Example

{
  "attempts": 1,
  "campaign_id": "cmp_2Yb7mCq9aPLk",
  "completed_at": "2026-11-02T09:17:30.000Z",
  "consent": true,
  "created_at": "2026-11-01T08:00:00.000Z",
  "id": "ctc_1aB2cD3eF4g",
  "last_attempt_at": "2026-11-02T09:14:00.000Z",
  "last_call_id": "call_3Hk9PqR2sT",
  "last_result": "answered",
  "livemode": true,
  "name": "Dana Levi",
  "next_attempt_at": null,
  "object": "campaign_contact",
  "outcome": "interested",
  "outcome_data": {
    "notes": "Wants the annual plan"
  },
  "phone": "+972501234567",
  "row": 2,
  "skip_reason": null,
  "status": "done",
  "timezone": null,
  "updated_at": "2026-11-02T09:17:30.000Z",
  "variables": {
    "plan": "Gold"
  }
}

400

The request is invalid: a parameter is missing, malformed or unknown, or the version header is unknown.

application/json

Every /v1 error.

object

error

required

object

code

required

A stable, machine-readable code from the error-code catalogue.

string

details

Structured context, e.g. required_scope or the compliance verdict.

object

key

additional properties

doc_url

required

A link to the documentation of this code.

string

message

required

A human-readable explanation. Do not parse it.

string

param

The request parameter the error relates to, e.g. to or metadata[order_id].

string

request_id

required

The X-Request-Id of this request. Quote it when you contact support.

string

type

required

The category of the error.

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error

Example

{
  "error": {
    "code": "parameter_missing",
    "doc_url": "https://docs.morevoice.ai/api/errors#parameter-missing",
    "message": "Missing required parameter: to.",
    "param": "to",
    "request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
    "type": "invalid_request_error"
  }
}

Headers

X-Request-Id

string

The request’s ID (req_…). Quote it when you contact support.

401

No valid API key was sent.

application/json

Every /v1 error.

object

error

required

object

code

required

A stable, machine-readable code from the error-code catalogue.

string

details

Structured context, e.g. required_scope or the compliance verdict.

object

key

additional properties

doc_url

required

A link to the documentation of this code.

string

message

required

A human-readable explanation. Do not parse it.

string

param

The request parameter the error relates to, e.g. to or metadata[order_id].

string

request_id

required

The X-Request-Id of this request. Quote it when you contact support.

string

type

required

The category of the error.

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error

Example

{
  "error": {
    "code": "invalid_api_key",
    "doc_url": "https://docs.morevoice.ai/api/errors#invalid-api-key",
    "message": "Invalid API key.",
    "request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
    "type": "authentication_error"
  }
}

Headers

X-Request-Id

string

The request’s ID (req_…). Quote it when you contact support.

403

The key may not do this (a missing scope, a plan limit, or a compliance block).

application/json

Every /v1 error.

object

error

required

object

code

required

A stable, machine-readable code from the error-code catalogue.

string

details

Structured context, e.g. required_scope or the compliance verdict.

object

key

additional properties

doc_url

required

A link to the documentation of this code.

string

message

required

A human-readable explanation. Do not parse it.

string

param

The request parameter the error relates to, e.g. to or metadata[order_id].

string

request_id

required

The X-Request-Id of this request. Quote it when you contact support.

string

type

required

The category of the error.

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error

Example

{
  "error": {
    "code": "missing_scope",
    "doc_url": "https://docs.morevoice.ai/api/errors#missing-scope",
    "message": "This API key lacks the calls:write scope.",
    "request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
    "type": "permission_error"
  }
}

Headers

X-Request-Id

string

The request’s ID (req_…). Quote it when you contact support.

404

No object with this ID exists in this organisation and mode.

application/json

Every /v1 error.

object

error

required

object

code

required

A stable, machine-readable code from the error-code catalogue.

string

details

Structured context, e.g. required_scope or the compliance verdict.

object

key

additional properties

doc_url

required

A link to the documentation of this code.

string

message

required

A human-readable explanation. Do not parse it.

string

param

The request parameter the error relates to, e.g. to or metadata[order_id].

string

request_id

required

The X-Request-Id of this request. Quote it when you contact support.

string

type

required

The category of the error.

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error

Example

{
  "error": {
    "code": "resource_missing",
    "doc_url": "https://docs.morevoice.ai/api/errors#resource-missing",
    "message": "No such object: 'call_4Gk2'.",
    "param": "id",
    "request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
    "type": "not_found"
  }
}

Headers

X-Request-Id

string

The request’s ID (req_…). Quote it when you contact support.

429

Too many requests, or no call capacity right now. Retry after the Retry-After delay.

application/json

Every /v1 error.

object

error

required

object

code

required

A stable, machine-readable code from the error-code catalogue.

string

details

Structured context, e.g. required_scope or the compliance verdict.

object

key

additional properties

doc_url

required

A link to the documentation of this code.

string

message

required

A human-readable explanation. Do not parse it.

string

param

The request parameter the error relates to, e.g. to or metadata[order_id].

string

request_id

required

The X-Request-Id of this request. Quote it when you contact support.

string

type

required

The category of the error.

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error

Example

{
  "error": {
    "code": "rate_limited",
    "doc_url": "https://docs.morevoice.ai/api/errors#rate-limited",
    "message": "Too many requests. Retry after 1 second.",
    "request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
    "type": "rate_limit_error"
  }
}

Headers

Retry-After

integer

Seconds to wait before retrying.

X-Request-Id

string

The request’s ID (req_…). Quote it when you contact support.

500

Something went wrong on MoreVoice’s side. Retry with the same Idempotency-Key.

application/json

Every /v1 error.

object

error

required

object

code

required

A stable, machine-readable code from the error-code catalogue.

string

details

Structured context, e.g. required_scope or the compliance verdict.

object

key

additional properties

doc_url

required

A link to the documentation of this code.

string

message

required

A human-readable explanation. Do not parse it.

string

param

The request parameter the error relates to, e.g. to or metadata[order_id].

string

request_id

required

The X-Request-Id of this request. Quote it when you contact support.

string

type

required

The category of the error.

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error

Example

{
  "error": {
    "code": "internal_error",
    "doc_url": "https://docs.morevoice.ai/api/errors#internal-error",
    "message": "Something went wrong on MoreVoice's side.",
    "request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
    "type": "api_error"
  }
}

Headers

X-Request-Id

string

The request’s ID (req_…). Quote it when you contact support.

Requeue or skip a campaign contact

Authorizations

Parameters

Path Parameters

Header Parameters

Example

Request Bodyrequired

Responses

200

Example

400

Example

Headers

401

Example

Headers

403

Example

Headers

404

Example

Headers

429

Example

Headers

500

Example

Headers

Request Body^required