Skip to main content
POST
/
v2
/
campaigns
/
{campaignId}
/
agent-source-restrictions
Create agent source restriction
curl --request POST \
  --url https://api.carecycle.ai/v2/campaigns/{campaignId}/agent-source-restrictions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "memberId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "restriction": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "<unknown>",
    "updatedAt": "<unknown>",
    "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "memberId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "campaignName": "<string>",
    "memberName": "<string>",
    "sourceName": "<string>"
  }
}
Create a restriction to block a specific member from receiving calls for a given Campaign routing configuration.

Authorizations

​
x-api-key
string
header
required

API key required for authentication.

Keys begin with 'cc_' prefix. Get your API key from the Developer Dashboard.

Path Parameters

​
campaignId
string<uuid>
required

Campaign ID

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

POST /v2/campaigns/:campaignId/agent-source-restrictions Request body

​
memberId
string<uuid>
required

Member/Agent ID

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
sourceId
string<uuid>
required

Source ID

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

POST /v2/campaigns/:campaignId/agent-source-restrictions Positive response

​
restriction
object
required

Created restriction record