GRgreenhouse
Blocked Spam Sources

Update blocked spam source

Updates the note on a blocked spam source. source_type and value are immutable on this endpoint — to change either, delete the entry and create a new one.

patch/v3/blocked_spam_sources/{id}

Request

  • Base URL
    https://harvest.greenhouse.io
  • URL
    https://harvest.greenhouse.io/v3/blocked_spam_sources/{id}
  • Auth
    • OAuth 2
      Authorization code: https://auth.greenhouse.io/authorize
      Client credentials
      Token URL: https://auth.greenhouse.io/token scopes: harvest:blocked_spam_sources:update
    • or HTTP bearer

Path parameters

idinteger required

Request body

notestring

Replacement annotation for the blocked spam source, typically used to record why the source was added or last touched (e.g. ticket id, internal incident reference). Limited to 255 characters. source_type and value are immutable — to change either, delete the entry and create a new one.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
source_type'ip_address' | 'cidr_block' | 'email_address' | 'email_domain'

Kind of identifier stored in value. ip_address is a single IPv4 or IPv6 address, cidr_block is an IPv4 or IPv6 CIDR range, email_address is a full address, and email_domain is the part after the @. Applications arriving from a matching source are rejected at intake with the reason Rejected by organization blocklist.

valuestring

The IP address, CIDR range, email address, or email domain to block, interpreted according to source_type. Stored lowercased and stripped of surrounding whitespace, so filtering by value is case-insensitive. Common consumer email domains (e.g. gmail.com, outlook.com, yahoo.com) cannot be blocked and are rejected on create.

notestring nullable

Free-text annotation set by the user who added or last updated the entry, typically used to record why the source was blocked. Limited to 255 characters; null when no note was provided.

Changes

No recorded changes to this operation across all 1 revision of this API.