Persons

Get person block status

Returns the block record for the specified person, indicating whether they are blocked from participating in referral campaigns and the reason for the block.

get/v5/persons/{person_id}/block

Request

Base URL
https://api.extole.io
Auth
- API key in header Authorization
- or API key in query parameter access_token
- or API key in cookie extole_token
TypeScript
https://skmtc.dev/extole/apis/integration-api-server-to-extole/docs/v5/persons/:person_id/block/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

person_idstring required

The Extole unique profile identifier of this user at Extole.

Response

Successful response

reasonstring required

Reason provided when the block was last updated. Absent when no reason was recorded.

type'EVENTS' | 'NONE' | 'REWARDS' required

Current block scope. EVENTS means event participation is blocked, REWARDS means reward fulfilment is blocked, NONE means unblocked.

updated_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Example response

{
  "updated_date": "2025-10-24T02:00:00-07:00"
}

Changes

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