| api

HTTP Request

POSThttps://staging.api-gw.propdata.net/users/api/v1/agents/branch-bulk-reassign-archive/

Example Response

{
  "id": 0,
  "agent": "string",
  "site": 0,
  "archive_agent_action": {
    "action": "string",
    "assign_to_agent": 0
  },
  "active": false,
  "username": "user@example.com",
  "full_name": "string",
  "portals": [],
  "designation": 0,
  "notification_preferences": {
    "application_accepted": false,
    "application_expired": false,
    "application_declined": false,
    "application_submitted": false,
    "deal_notify_sale_new": false,
    "deal_notify_sale_final": false,
    "deal_notify_sale_closed": false,
    "deal_notify_sale_cancelled": false,
    "deal_notify_sale_activities_expired": false,
    "lead_new": false,
    "listing_mandate_expiry": false,
    "listing_property_updated": false,
    "referral_new": false,
    "referral_update": false,
    "referral_transaction": false,
    "valuation_new": false,
    "valuation_approved": false,
    "valuation_published": false
  },
  "testimonials": [],
  "qualifications": [],
  "employment_history": [],
  "awards": [],
  "vehicles": [],
  "meta": {},
  "created": "2025-07-17T08:32:26.337Z",
  "modified": "2025-07-17T08:32:26.337Z",
  "deleted": "2025-07-17T08:32:26.337Z",
  "uuid": "770bba28-9f80-4d40-9c51-6e022364af91",
  "source_ref": "string",
  "title": "string",
  "first_name": "string",
  "last_name": "string",
  "preferred_name": "string",
  "full_name_slug": "string",
  "email": "user@example.com",
  "id_number": "string",
  "gender": "string",
  "user_website": "string",
  "country_code": "string",
  "cell_number": "string",
  "whatsapp_number": "string",
  "resume": "string",
  "resignation_date": "string",
  "privy_seal_id": "string",
  "ooba_obi_tracking_code": "string",
  "website_url": "http://www.example.com",
  "blog_url": "http://www.example.com",
  "facebook_url": "http://www.example.com",
  "twitter_url": "http://www.example.com",
  "linkedin_url": "http://www.example.com",
  "youtube_url": "http://www.example.com",
  "pinterest_url": "http://www.example.com",
  "google_my_business_url": "http://www.example.com",
  "instagram_url": "http://www.example.com",
  "vimeo_url": "http://www.example.com",
  "physical_address": "string",
  "postal_address": "string",
  "home_number": "string",
  "income_tax_ref_number": "string",
  "fidelity_fund_number": "string",
  "fidelity_fund_certificate_status": "string",
  "affairs_board_exam": false,
  "bank": "string",
  "account_holder": "string",
  "account_number": "string",
  "bank_branch": "string",
  "bank_branch_code": "string",
  "account_type": "string",
  "tax_name_of_firm": "string",
  "tax_consultant_name": "string",
  "tax_physical_address": "string",
  "tax_postal_address": "string",
  "tax_office_number": "string",
  "tax_fax": "string",
  "tax_email_address": "user@example.com",
  "facebook_verification_key": "string",
  "facebook_tracking_keys": [],
  "adwords_tracking_keys": [],
  "linkedin_tracking_keys": [],
  "feed_facebook_listings": false,
  "feed_facebook_news": false,
  "facebook_app_id": "string",
  "facebook_app_secret": "string",
  "facebook_profile_id": "string",
  "facebook_oauth_access_token": "string",
  "facebook_page_token": "string",
  "profile_picture_coord_x": -2147483648,
  "profile_picture_coord_y": -2147483648,
  "profile_picture_width": -2147483648,
  "profile_picture_height": -2147483648,
  "commencement_date": "string",
  "image": -2147483648,
  "signature_image": -2147483648,
  "signature_image_coord_x": -2147483648,
  "signature_image_coord_y": -2147483648,
  "signature_image_width": -2147483648,
  "signature_image_height": -2147483648,
  "fidelity_fund_certificate": -2147483648,
  "documents": [],
  "branches": [],
  "display_on_branches": [],
  "activate_account_hash": "string",
  "activate_account_expires": "2025-07-17T08:32:26.337Z",
  "account_activated": false,
  "serviced_suburbs": [],
  "serviced_areas": [],
  "serviced_listing_types": [],
  "serviced_property_types": [],
  "serviced_property_zoning": [],
  "search_vector": "string",
  "birthday_date": "string",
  "private_documents": [],
  "target_type": "string",
  "number_of_people_canvassed": -2147483648,
  "number_of_valuations": -2147483648,
  "mandates_created": -2147483648,
  "sole_mandates_created": -2147483648,
  "property_matches_sent": -2147483648,
  "viewings": -2147483648,
  "show_houses": -2147483648,
  "feedback_requests_sent": -2147483648,
  "listings_sold": -2147483648,
  "listings_created": -2147483648,
  "listings_sold_value": "0.00",
  "monthly_net_commission": "0.00",
  "commission_split": "0.00",
  "bond_commission_split": "0.00",
  "deduct_franchise_fee": false,
  "nqf_level": -2147483648,
  "pde_level": -2147483648,
  "training_payment_option": false,
  "training_payment_date": "string",
  "default_home_page": "string",
  "statistics": 0,
  "group_old": 0,
  "group": 0,
  "race": 0,
  "user": 0,
  "pending_user": 0,
  "schedule": 0
}

Name	Description
id	integer ID
agent	string Agent
site	integer Site
archive_agent_action	object
active required	boolean Active
username nullable	string Username
full_name	stringnon-empty Full name
portals	array of integers Choices: [ 1,2,3...2147483648 ]
designation required	integer Designation
notification_preferences	object
testimonials	array of integers Choices: [ 1,2,3...2147483648 ]
qualifications	array of integers Choices: [ 1,2,3...2147483648 ]
employment_history	array of integers Choices: [ 1,2,3...2147483648 ]
awards	array Choices: [ 1,2,3...2147483648 ]
vehicles	array of integers Choices: [ 1,2,3...2147483648 ]
meta	string Meta
created	string Created
modified	string Modified
deleted nullable	string Deleted
uuid	string Uuid
source_ref nullable	string<= 100 characters Source ref
title nullable	string Title Choices: MrMrsMissMsDrMr & MrsMr & MrMrs & Mrs
first_name required	string[ 1...50 ] characters First name
last_name required	string[ 1...50 ] characters Last name
preferred_name nullable	string<= 50 characters Preferred name
full_name_slug nullable	string<= 120 characters Full name slug
email required	string[ 1...254 ] characters Email
id_number nullable	string<= 13 characters Id number
gender nullable	string Gender Choices: FemaleMaleTransgenderGender NeutralNon-binaryOther
user_website nullable	string<= 50 characters User website
country_code nullable	string<= 10 characters Country code
cell_number required	string[ 1...20 ] characters Cell number
whatsapp_number	string<= 40 characters Whatsapp number
resume nullable	string Resume
resignation_date nullable	string Resignation date
privy_seal_id nullable	string<= 200 characters Privy seal id
ooba_obi_tracking_code nullable	string<= 50 characters Ooba obi tracking code
website_url nullable	string<= 100 characters Website url
blog_url nullable	string<= 100 characters Blog url
facebook_url nullable	string<= 200 characters Facebook url
twitter_url nullable	string<= 100 characters Twitter url
linkedin_url nullable	string<= 100 characters Linkedin url
youtube_url nullable	string<= 100 characters Youtube url
pinterest_url nullable	string<= 100 characters Pinterest url
google_my_business_url nullable	string<= 100 characters Google my business url
instagram_url nullable	string<= 100 characters Instagram url
vimeo_url nullable	string<= 100 characters Vimeo url
physical_address nullable	string Physical address
postal_address nullable	string Postal address
home_number nullable	string<= 20 characters Home number
income_tax_ref_number nullable	string<= 30 characters Income tax ref number
fidelity_fund_number nullable	string<= 30 characters Fidelity fund number
fidelity_fund_certificate_status nullable	string<= 100 characters Fidelity fund certificate status
affairs_board_exam	boolean Affairs board exam
bank nullable	string<= 30 characters Bank
account_holder nullable	string<= 30 characters Account holder
account_number nullable	string<= 30 characters Account number
bank_branch nullable	string<= 30 characters Bank branch
bank_branch_code nullable	string<= 30 characters Bank branch code
account_type nullable	string<= 30 characters Account type
tax_name_of_firm nullable	string<= 254 characters Tax name of firm
tax_consultant_name nullable	string<= 254 characters Tax consultant name
tax_physical_address nullable	string Tax physical address
tax_postal_address nullable	string Tax postal address
tax_office_number nullable	string<= 30 characters Tax office number
tax_fax nullable	string<= 30 characters Tax fax
tax_email_address nullable	string<= 254 characters Tax email address
facebook_verification_key nullable	string<= 50 characters Facebook verification key
facebook_tracking_keys nullable	array of strings Facebook tracking keys Choices: [ 1,2,3...2147483648 ]
adwords_tracking_keys nullable	array of strings Adwords tracking keys Choices: [ 1,2,3...2147483648 ]
linkedin_tracking_keys nullable	array of strings Linkedin tracking keys Choices: [ 1,2,3...2147483648 ]
feed_facebook_listings	boolean Feed facebook listings
feed_facebook_news	boolean Feed facebook news
facebook_app_id nullable	string<= 50 characters Facebook app id
facebook_app_secret nullable	string<= 50 characters Facebook app secret
facebook_profile_id nullable	string<= 50 characters Facebook profile id
facebook_oauth_access_token nullable	string Facebook oauth access token
facebook_page_token nullable	string Facebook page token
profile_picture_coord_x nullable	integer Profile picture coord x
profile_picture_coord_y nullable	integer Profile picture coord y
profile_picture_width nullable	integer Profile picture width
profile_picture_height nullable	integer Profile picture height
commencement_date nullable	string Commencement date
image nullable	integer Image
signature_image nullable	integer Signature image
signature_image_coord_x nullable	integer Signature image coord x
signature_image_coord_y nullable	integer Signature image coord y
signature_image_width nullable	integer Signature image width
signature_image_height nullable	integer Signature image height
fidelity_fund_certificate nullable	integer Fidelity fund certificate
documents nullable	array of integers Documents Choices: [ 1,2,3...2147483648 ]
branches required	array of integers Branches Choices: [ 1,2,3...2147483648 ]
display_on_branches nullable	array of integers Display on branches Choices: [ 1,2,3...2147483648 ]
activate_account_hash nullable	string<= 250 characters Activate account hash
activate_account_expires nullable	string Activate account expires
account_activated	boolean Account activated
serviced_suburbs nullable	array of integers Serviced suburbs Choices: [ 1,2,3...2147483648 ]
serviced_areas nullable	array of integers Serviced areas Choices: [ 1,2,3...2147483648 ]
serviced_listing_types nullable	array of strings Serviced listing types Choices: For SaleTo Let
serviced_property_types nullable	array of strings Serviced property types Choices: Airport HangerApartmentApartment BlockBar/PubBed & BreakfastBuildingBungalowBusinessBusiness CentreChaletClubClusterCo-working SpaceCompoundContractDetachedDuetDuplexEquestrian PropertyFactoryFarmFlatFreeholdFreestandingFull FloorGarden CottageGated EstateGolf EstateGuest HouseGuesthouseHalf FloorHotelHotel RoomHouseIndustrial YardInvestmentLabour CampLeasebackLodgeMaisonetteMedical CentreMedical SuiteMini FactoryOfficePackage HomePenthousePlace of WorshipRestaurantRetailRetirement UnitRoomSectional TitleSemi DetachedService StationServiced OfficeShopping CentreShowroomSimplexSmall HoldingStaff AccommodationStorage UnitStudio ApartmentTownhouseTraining FacilityUnitsVacant LandVillaWarehouseWorkshop
serviced_property_zoning nullable	array of strings Serviced property zoning Choices: ResidentialResidential New DevelopmentResidential EstateCommercialCommercial New DevelopmentCommercial EstateIndustrialRetailAgriculturalMixed UseHoliday Letting
search_vector nullable	string Search vector
birthday_date nullable	string Birthday date
private_documents nullable	array of integers Private documents Choices: [ 1,2,3...2147483648 ]
target_type nullable	string Target type Choices: MonthlyQuarterlyYearly
number_of_people_canvassed nullable	integer Number of people canvassed
number_of_valuations nullable	integer Number of valuations
mandates_created nullable	integer Mandates created
sole_mandates_created nullable	integer Sole mandates created
property_matches_sent nullable	integer Property matches sent
viewings nullable	integer Viewings
show_houses nullable	integer Show houses
feedback_requests_sent nullable	integer Feedback requests sent
listings_sold nullable	integer Listings sold
listings_created nullable	integer Listings created
listings_sold_value nullable	string Listings sold value
monthly_net_commission nullable	string Monthly net commission
commission_split nullable	string Commission split
bond_commission_split nullable	string Bond commission split
deduct_franchise_fee	boolean Deduct franchise fee
nqf_level nullable	integer Nqf level
pde_level nullable	integer Pde level
training_payment_option	boolean Training payment option
training_payment_date nullable	string Training payment date
default_home_page	string[ 1...255 ] characters Default home page
statistics nullable	integer Statistics
group_old nullable	integer Group old
group nullable	integer Group
race nullable	integer Race
user nullable	integer User
pending_user nullable	integer Pending user
schedule nullable	integer Schedule

Name

Description

integer

agent

string

Agent

site

integer

Site

archive_agent_action

object

active

required

boolean

Active

username

nullable

string

Username

full_name

stringnon-empty

Full name

portals

array of integers

Choices: [ 1,2,3...2147483648 ]

designation

required

integer

Designation

notification_preferences

object

testimonials

array of integers

Choices: [ 1,2,3...2147483648 ]

qualifications

array of integers

Choices: [ 1,2,3...2147483648 ]

employment_history

array of integers

Choices: [ 1,2,3...2147483648 ]

awards

array

Choices: [ 1,2,3...2147483648 ]

vehicles

array of integers

Choices: [ 1,2,3...2147483648 ]

Meta

created

string

Created

modified

string

Modified

deleted

nullable

string

Deleted

uuid

string

Uuid

source_ref

nullable

string<= 100 characters

Source ref

title

nullable

string

Title

Choices: MrMrsMissMsDrMr & MrsMr & MrMrs & Mrs

first_name

required

string[ 1...50 ] characters

First name

last_name

required

string[ 1...50 ] characters

Last name

preferred_name

nullable

string<= 50 characters

Preferred name

full_name_slug

nullable

string<= 120 characters

Full name slug

required

string[ 1...254 ] characters

id_number

nullable

string<= 13 characters

Id number

gender

nullable

string

Gender

Choices: FemaleMaleTransgenderGender NeutralNon-binaryOther

user_website

nullable

string<= 50 characters

User website

country_code

nullable

string<= 10 characters

Country code

cell_number

required

string[ 1...20 ] characters

Cell number

whatsapp_number

string<= 40 characters

Whatsapp number

resume

nullable

string

Resume

resignation_date

nullable

string

Resignation date

privy_seal_id

nullable

string<= 200 characters

Privy seal id

ooba_obi_tracking_code

nullable

string<= 50 characters

Ooba obi tracking code

website_url

nullable

string<= 100 characters

Website url

blog_url

nullable

string<= 100 characters

Blog url

facebook_url

nullable

string<= 200 characters

Facebook url

twitter_url

nullable

string<= 100 characters

Twitter url

linkedin_url

nullable

string<= 100 characters

Linkedin url

youtube_url

nullable

string<= 100 characters

Youtube url

pinterest_url

nullable

string<= 100 characters

Pinterest url

google_my_business_url

nullable

string<= 100 characters

Google my business url

instagram_url

nullable

string<= 100 characters

Instagram url

vimeo_url

nullable

string<= 100 characters

Vimeo url

physical_address

nullable

string

Physical address

postal_address

nullable

string

Postal address

home_number

nullable

string<= 20 characters

Home number

income_tax_ref_number

nullable

string<= 30 characters

Income tax ref number

fidelity_fund_number

nullable

string<= 30 characters

Fidelity fund number

fidelity_fund_certificate_status

nullable

string<= 100 characters

Fidelity fund certificate status

affairs_board_exam

boolean

Affairs board exam

bank

nullable

string<= 30 characters

Bank

account_holder

nullable

string<= 30 characters

Account holder

account_number

nullable

string<= 30 characters

Account number

bank_branch

nullable

string<= 30 characters

Bank branch

bank_branch_code

nullable

string<= 30 characters

Bank branch code

account_type

nullable

string<= 30 characters

Account type

tax_name_of_firm

nullable

string<= 254 characters

Tax name of firm

tax_consultant_name

nullable

string<= 254 characters

Tax consultant name

tax_physical_address

nullable

string

Tax physical address

tax_postal_address

nullable

string

Tax postal address

tax_office_number

nullable

string<= 30 characters

Tax office number

tax_fax

nullable

string<= 30 characters

Tax fax

tax_email_address

nullable

string<= 254 characters

Tax email address

facebook_verification_key

nullable

string<= 50 characters

Facebook verification key

facebook_tracking_keys

nullable

array of strings

Facebook tracking keys

Choices: [ 1,2,3...2147483648 ]

adwords_tracking_keys

nullable

array of strings

Adwords tracking keys

Choices: [ 1,2,3...2147483648 ]

linkedin_tracking_keys

nullable

array of strings

Linkedin tracking keys

Choices: [ 1,2,3...2147483648 ]

feed_facebook_listings

boolean

Feed facebook listings

feed_facebook_news

boolean

Feed facebook news

facebook_app_id

nullable

string<= 50 characters

Facebook app id

facebook_app_secret

nullable

string<= 50 characters

Facebook app secret

facebook_profile_id

nullable

string<= 50 characters

Facebook profile id

facebook_oauth_access_token

nullable

string

Facebook oauth access token

facebook_page_token

nullable

string

Facebook page token

profile_picture_coord_x

nullable

integer

Profile picture coord x

profile_picture_coord_y

nullable

integer

Profile picture coord y

profile_picture_width

nullable

integer

Profile picture width

profile_picture_height

nullable

integer

Profile picture height

commencement_date

nullable

string

Commencement date

image

nullable

integer

Image

signature_image

nullable

integer

Signature image

signature_image_coord_x

nullable

integer

Signature image coord x

signature_image_coord_y

nullable

integer

Signature image coord y

signature_image_width

nullable

integer

Signature image width

signature_image_height

nullable

integer

Signature image height

fidelity_fund_certificate

nullable

integer

Fidelity fund certificate

documents

nullable

array of integers

Documents

Choices: [ 1,2,3...2147483648 ]

branches

required

array of integers

Branches

Choices: [ 1,2,3...2147483648 ]

display_on_branches

nullable

array of integers

Display on branches

Choices: [ 1,2,3...2147483648 ]

activate_account_hash

nullable

string<= 250 characters

Activate account hash

activate_account_expires

nullable

string

Activate account expires

account_activated

boolean

Account activated

serviced_suburbs

nullable

array of integers

Serviced suburbs

Choices: [ 1,2,3...2147483648 ]

serviced_areas

nullable

array of integers

Serviced areas

Choices: [ 1,2,3...2147483648 ]

serviced_listing_types

nullable

array of strings

Serviced listing types

Choices: For SaleTo Let

serviced_property_types

nullable

array of strings

Serviced property types

Choices: Airport HangerApartmentApartment BlockBar/PubBed & BreakfastBuildingBungalowBusinessBusiness CentreChaletClubClusterCo-working SpaceCompoundContractDetachedDuetDuplexEquestrian PropertyFactoryFarmFlatFreeholdFreestandingFull FloorGarden CottageGated EstateGolf EstateGuest HouseGuesthouseHalf FloorHotelHotel RoomHouseIndustrial YardInvestmentLabour CampLeasebackLodgeMaisonetteMedical CentreMedical SuiteMini FactoryOfficePackage HomePenthousePlace of WorshipRestaurantRetailRetirement UnitRoomSectional TitleSemi DetachedService StationServiced OfficeShopping CentreShowroomSimplexSmall HoldingStaff AccommodationStorage UnitStudio ApartmentTownhouseTraining FacilityUnitsVacant LandVillaWarehouseWorkshop

serviced_property_zoning

nullable

array of strings

Serviced property zoning

Choices: ResidentialResidential New DevelopmentResidential EstateCommercialCommercial New DevelopmentCommercial EstateIndustrialRetailAgriculturalMixed UseHoliday Letting

search_vector

nullable

string

Search vector

birthday_date

nullable

string

Birthday date

private_documents

nullable

array of integers

Private documents

Choices: [ 1,2,3...2147483648 ]

target_type

nullable

string

Target type

Choices: MonthlyQuarterlyYearly

number_of_people_canvassed

nullable

integer

Number of people canvassed

number_of_valuations

nullable

integer

Number of valuations

mandates_created

nullable

integer

Mandates created

sole_mandates_created

nullable

integer

Sole mandates created

property_matches_sent

nullable

integer

Property matches sent

viewings

nullable

integer

Viewings

show_houses

nullable

integer

Show houses

feedback_requests_sent

nullable

integer

Feedback requests sent

listings_sold

nullable

integer

Listings sold

listings_created

nullable

integer

Listings created

listings_sold_value

nullable

string

Listings sold value

monthly_net_commission

nullable

string

Monthly net commission

commission_split

nullable

string

Commission split

bond_commission_split

nullable

string

Bond commission split

deduct_franchise_fee

boolean

Deduct franchise fee

nqf_level

nullable

integer

Nqf level

pde_level

nullable

integer

Pde level

training_payment_option

boolean

Training payment option

training_payment_date

nullable

string

Training payment date

default_home_page

string[ 1...255 ] characters

Default home page

statistics

nullable

integer

Statistics

group_old

nullable

integer

Group old

group

nullable

integer

Group

race

nullable

integer

Race

user

nullable

integer

User

pending_user

nullable

integer

Pending user

schedule

nullable

integer

Schedule

Responses

201