Customer Block API

Block phone numbers

Block phone numbers

post

Block phone numbers for an advisor.

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Path parameters

advisorSymphonyIdstringRequired

The symphonyId for which we are blocking the phone numbers

Pattern: ^\d+$

Body

application/json

Responses

200

Request processed

application/json

403

Forbidden

application/json

404

Not found

application/json

post

/api/v1/customer/advisors/{advisorSymphonyId}/blockedPhoneNumbers

HTTPcURLJavaScriptPython

POST /api/v1/customer/advisors/{advisorSymphonyId}/blockedPhoneNumbers HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "phoneNumbers": [
    {
      "phoneNumber": "text",
      "reason": "SPAM",
      "comment": "text"
    }
  ]
}

{
  "phoneNumbers": [
    {
      "phoneNumber": "text",
      "status": 1,
      "error": {
        "itemId": "text",
        "type": "https://zalando.github.io/problem/constraint-violation",
        "title": "text",
        "statusCode": 503,
        "detail": "Connection to database timed out",
        "instance": "https://example.com",
        "parameters": {
          "additionalProp1": "text",
          "additionalProp2": "text",
          "additionalProp3": "text"
        }
      }
    }
  ]
}

Get blocked phone numbers

Get blocked phone numbers

get

Get blocked phone numbers for an advisor.

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Path parameters

advisorSymphonyIdstringRequired

The Symphony ID for which we are getting the blocked phone numbers

Pattern: ^\d+$

Responses

200

Request processed

application/json

403

Forbidden

application/json

404

Forbidden

application/json

get

/api/v1/customer/advisors/{advisorSymphonyId}/blockedPhoneNumbers

HTTPcURLJavaScriptPython

GET /api/v1/customer/advisors/{advisorSymphonyId}/blockedPhoneNumbers HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "phoneNumbers": [
    {
      "phoneNumber": "text",
      "reason": "SPAM",
      "comment": "text"
    }
  ]
}

Unblock phone numbers

Unblock phone numbers (recommended)

delete

Unblock phone numbers for an advisor.

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Path parameters

advisorSymphonyIdstringRequired

The Symphony ID for which we are unblocking the phone numbers

Pattern: ^\d+$

Responses

200

Request processed

application/json

403

Forbidden

application/json

404

Not found

application/json

delete

/api/v2/customer/advisors/{advisorSymphonyId}/blockedPhoneNumbers

HTTPcURLJavaScriptPython

DELETE /api/v2/customer/advisors/{advisorSymphonyId}/blockedPhoneNumbers HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "phoneNumbers": [
    {
      "phoneNumber": "text",
      "status": 1,
      "error": {
        "itemId": "text",
        "type": "https://zalando.github.io/problem/constraint-violation",
        "title": "text",
        "statusCode": 503,
        "detail": "Connection to database timed out",
        "instance": "https://example.com",
        "parameters": {
          "additionalProp1": "text",
          "additionalProp2": "text",
          "additionalProp3": "text"
        }
      }
    }
  ]
}