Block Contact

Blocks a Contact.

post

Path parameters

idstringRequired

The Contact ID.

Responses

200

OK

application/json

400

Bad Request

application/json

post

HTTPcURLJavaScriptPython

POST /public/v1/notifications/contacts/{id}/block HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-06-02T00:30:06.132Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-06-02T00:30:06.132Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "activated": {
      "at": "2025-06-02T00:30:06.132Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "blocked": {
      "at": "2025-06-02T00:30:06.132Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "deleted": {
      "at": "2025-06-02T00:30:06.132Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "blockedReason": "text",
  "email": "text",
  "name": "text",
  "optOuts": [
    {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-06-02T00:30:06.132Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "updated": {
          "at": "2025-06-02T00:30:06.132Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "published": {
          "at": "2025-06-02T00:30:06.132Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "unpublished": {
          "at": "2025-06-02T00:30:06.132Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "deleted": {
          "at": "2025-06-02T00:30:06.132Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "description": "text",
      "optOutAllowed": true,
      "shortDescription": "text",
      "status": "text",
      "name": "text",
      "note": "text",
      "icon": "text",
      "statistics": {
        "month": {
          "bounced": 1,
          "complained": 1,
          "discarded": 1,
          "failed": 1,
          "sent": 1,
          "total": 1
        },
        "today": {
          "bounced": 1,
          "complained": 1,
          "discarded": 1,
          "failed": 1,
          "sent": 1,
          "total": 1
        },
        "week": {
          "bounced": 1,
          "complained": 1,
          "discarded": 1,
          "failed": 1,
          "sent": 1,
          "total": 1
        }
      }
    }
  ],
  "status": "text",
  "userId": "text",
  "user": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2025-06-02T00:30:06.132Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "updated": {
        "at": "2025-06-02T00:30:06.132Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "invitationAcceptedAt": "2025-06-02T00:30:06.132Z"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "email": "text",
    "status": "text",
    "phone": {
      "prefix": "text",
      "number": "text"
    },
    "firstName": "text",
    "lastName": "text",
    "icon": "text",
    "lastLoginAt": "2025-06-02T00:30:06.132Z",
    "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"
    }
  }
}