Block Contact

Blocks a Contact.

post

Path parameters

idstringRequired

The Contact ID.

Responses

200

OK

application/json

idstringOptional

blockedReasonstring · nullableOptional

emailstringOptional

namestring · nullableOptional

statusstringOptional

userIdstring · nullableOptional

400

Bad Request

application/json

post

/public/v1/notifications/contacts/{id}/block

HTTPcURLJavaScriptPython

POST /public/v1/notifications/contacts/{id}/block HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-02-19T17:45:19.850Z",
      "by": {}
    },
    "updated": {
      "at": "2026-02-19T17:45:19.850Z",
      "by": {}
    },
    "activated": {
      "at": "2026-02-19T17:45:19.850Z",
      "by": {}
    },
    "blocked": {
      "at": "2026-02-19T17:45:19.850Z",
      "by": {}
    },
    "deleted": {
      "at": "2026-02-19T17:45:19.850Z",
      "by": {}
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "blockedReason": "text",
  "email": "text",
  "name": "text",
  "optOuts": [
    {
      "id": "text",
      "description": "text",
      "name": "text",
      "icon": "text",
      "lastUsed": "2026-02-19T17:45:19.850Z"
    }
  ],
  "status": "text",
  "userId": "text",
  "user": {
    "id": "text",
    "audit": {
      "created": {},
      "updated": {},
      "invitationAcceptedAt": "2026-02-19T17:45:19.850Z"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "email": "text",
    "status": "text",
    "phone": {
      "prefix": "text",
      "number": "text"
    },
    "firstName": "text",
    "lastName": "text",
    "icon": "text",
    "lastLoginAt": "2026-02-19T17:45:19.850Z",
    "settings": {
      "cultureCode": "text",
      "languageCode": "text"
    },
    "name": "text",
    "accounts": [
      {
        "id": "text",
        "icon": "text",
        "type": "text",
        "status": "text",
        "name": "text"
      }
    ],
    "currentAccount": {
      "id": "text",
      "icon": "text",
      "type": "text",
      "status": "text",
      "name": "text"
    }
  }
}