Block contact

Blocks a contact.

post

Blocks the contact, preventing them from receiving any notifications until unblocked.

Path parameters

idstringRequired

The Contact ID.

Responses

200

OK

application/json

Represents a notification contact who can receive email notifications.

idstringOptional

revisioninteger · int32Optional

namestring · nullableOptional

blockedReasonstring · nullableOptional

emailstringOptional

statusstringOptional

chatbooleanOptional

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-07-20T23:59:55.675Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-07-20T23:59:55.675Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "activated": {
      "at": "2026-07-20T23:59:55.675Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "blocked": {
      "at": "2026-07-20T23:59:55.675Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "deleted": {
      "at": "2026-07-20T23:59:55.675Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "revision": 1,
  "name": "text",
  "blockedReason": "text",
  "email": "text",
  "status": "text",
  "identity": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-07-20T23:59:55.675Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-07-20T23:59:55.675Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "directories": [
    {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-07-20T23:59:55.675Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-07-20T23:59:55.675Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "revision": 1,
      "account": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-07-20T23:59:55.675Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-07-20T23:59:55.675Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "icon": "text",
        "revision": 1,
        "type": "Client",
        "status": "Active",
        "externalIds": {
          "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "externalId": "text",
        "externalName": "text",
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "technicalSupportEmail": "text",
        "website": "text",
        "description": "text",
        "groups": [
          {
            "id": "text",
            "name": "text",
            "revision": 1,
            "description": "text",
            "logo": "text",
            "isDefault": true
          }
        ],
        "eligibility": {
          "client": true,
          "partner": true
        },
        "defaultLanguageCode": "text"
      },
      "origin": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-07-20T23:59:55.675Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-07-20T23:59:55.675Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "icon": "text",
        "revision": 1,
        "type": "Client",
        "status": "Active",
        "externalIds": {
          "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "externalId": "text",
        "externalName": "text",
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "technicalSupportEmail": "text",
        "website": "text",
        "description": "text",
        "groups": [
          {
            "id": "text",
            "name": "text",
            "revision": 1,
            "description": "text",
            "logo": "text",
            "isDefault": true
          }
        ],
        "eligibility": {
          "client": true,
          "partner": true
        },
        "defaultLanguageCode": "text"
      },
      "type": "text",
      "contacts": [
        {
          "id": "text",
          "audit": {
            "created": {
              "at": "2026-07-20T23:59:55.675Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2026-07-20T23:59:55.675Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "activated": {
              "at": "2026-07-20T23:59:55.675Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "blocked": {
              "at": "2026-07-20T23:59:55.675Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "deleted": {
              "at": "2026-07-20T23:59:55.675Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "revision": 1,
          "name": "text",
          "blockedReason": "text",
          "email": "text",
          "status": "text",
          "identity": {
            "id": "text",
            "audit": {
              "created": {
                "at": "2026-07-20T23:59:55.675Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "updated": {
                "at": "2026-07-20T23:59:55.675Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "name": "text",
            "icon": "text",
            "revision": 1
          },
          "directories": [
            "[Circular Reference]"
          ],
          "chat": true,
          "optOuts": [
            {
              "id": "text",
              "audit": {
                "created": {
                  "at": "2026-07-20T23:59:55.675Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                },
                "updated": {
                  "at": "2026-07-20T23:59:55.675Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                },
                "published": {
                  "at": "2026-07-20T23:59:55.675Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                },
                "unpublished": {
                  "at": "2026-07-20T23:59:55.675Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                },
                "deleted": {
                  "at": "2026-07-20T23:59:55.675Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                }
              },
              "$meta": {
                "omitted": [
                  "text"
                ]
              },
              "name": "text",
              "revision": 1,
              "description": "text",
              "optOutAllowed": true,
              "status": "text",
              "note": "text",
              "deleteAllowed": true,
              "statistics": {
                "month": 1,
                "today": 1,
                "week": 1
              },
              "lastUsed": "2026-07-20T23:59:55.675Z",
              "enabledByDefault": true
            }
          ],
          "user": {
            "id": "text",
            "audit": {
              "created": {
                "at": "2026-07-20T23:59:55.675Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "updated": {
                "at": "2026-07-20T23:59:55.675Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "invitationAcceptedAt": "2026-07-20T23:59:55.675Z"
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "name": "text",
            "icon": "text",
            "revision": 1,
            "email": "text",
            "status": "text",
            "phone": {
              "prefix": "text",
              "number": "text"
            },
            "firstName": "text",
            "lastName": "text",
            "lastLoginAt": "2026-07-20T23:59:55.675Z",
            "settings": {
              "cultureCode": "text",
              "dateFormat": "text",
              "languageCode": "text",
              "numberFormat": {
                "decimalSeparator": "text",
                "groupSeparator": "text"
              },
              "timeFormat": "text",
              "timeZone": "text",
              "optOuts": {
                "objectTypes": [
                  "text"
                ]
              }
            },
            "accounts": [
              {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1,
                "type": "Client",
                "status": "Active"
              }
            ],
            "currentAccount": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1,
              "type": "Client",
              "status": "Active"
            }
          }
        }
      ]
    }
  ],
  "chat": true,
  "optOuts": [
    {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-07-20T23:59:55.675Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-07-20T23:59:55.675Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "published": {
          "at": "2026-07-20T23:59:55.675Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "unpublished": {
          "at": "2026-07-20T23:59:55.675Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "deleted": {
          "at": "2026-07-20T23:59:55.675Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "revision": 1,
      "description": "text",
      "optOutAllowed": true,
      "status": "text",
      "note": "text",
      "deleteAllowed": true,
      "statistics": {
        "month": 1,
        "today": 1,
        "week": 1
      },
      "lastUsed": "2026-07-20T23:59:55.675Z",
      "enabledByDefault": true
    }
  ],
  "user": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-07-20T23:59:55.675Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-07-20T23:59:55.675Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "invitationAcceptedAt": "2026-07-20T23:59:55.675Z"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "icon": "text",
    "revision": 1,
    "email": "text",
    "status": "text",
    "phone": {
      "prefix": "text",
      "number": "text"
    },
    "firstName": "text",
    "lastName": "text",
    "lastLoginAt": "2026-07-20T23:59:55.675Z",
    "settings": {
      "cultureCode": "text",
      "dateFormat": "text",
      "languageCode": "text",
      "numberFormat": {
        "decimalSeparator": "text",
        "groupSeparator": "text"
      },
      "timeFormat": "text",
      "timeZone": "text",
      "optOuts": {
        "objectTypes": [
          "text"
        ]
      }
    },
    "accounts": [
      {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1,
        "type": "Client",
        "status": "Active"
      }
    ],
    "currentAccount": {
      "id": "text",
      "name": "text",
      "icon": "text",
      "revision": 1,
      "type": "Client",
      "status": "Active"
    }
  }
}