Update Broker

PUT 
/brokers/:id

Update Broker

Request

Path Parameters

id stringrequired

application/json

Body

name string

Name

tags string

Tags

type string

Type

Possible values: [Broker, Agent, Agency, Consultant, Other]

firstName string

First Name

lastName string

Last Name

email string

Email

phone string

Phone

brokerAssignments

object[]

Array [

brokerId string

Broker

institutionId string

Institution

campaignId string

Campaign

tags string

Tags

]

notes

object[]

Array [

note string

Note

tags string

Tags

]

documents

object[]

Array [

tags string

Tags

type string

Type

name string

Name

fileName string

File Name

notes string

Notes

visibility string

Visibility

]

contactMethods

object[]

Array [

tags string

Tags

type string

Type

Possible values: [Phone, Email, Fax, Mobile, WhatsApp, Facebook, Twitter, Instagram, LinkedIn, Skype, Other]

name string

Name

value string

Value

priority number

Priority

preferences string

Preferences

notes string

Notes

confirmed string

Confirmed

]

commissions

object[]

Array [

campaignId string

Campaign

type string

Type

Possible values: [Fixed, Percentage]

value number

Value

effective string

Effective

expires string

Expires

tags string

Tags

institutionId string

Institution

]

addresses

object[]

Array [

type string

Type

isPrimary string

Is Primary

name string

Name

organization string

Organization

address1 string

Address1

address2 string

Address2

address3 string

Address3

city string

City

region string

Region

postalCode string

Postal Code

country string

Country

phoneNumber string

Phone Number

notes string

Notes

tags string

Tags

]

brokerPreferences

object[]

Array [

brokerId string

Broker

key string

Key

value string

Value

strict string

Strict

notes string

Notes

tags string

Tags

]

brokerRelationships

object[]

Array [

brokerId string

Broker

relatedId string

Related

relationship string

Relationship

tags string

Tags

]

commissionPayouts

object[]

Array [

brokerId string

Broker

campaignId string

Campaign

bookingId string

Booking

type string

Type

value number

Value

effective string

Effective

memberId string

Member

tripId string

Trip

paymentId string

Payment

status string

Status

]

commissionsByPeriods

object[]

Array [

brokerId string

Broker

campaignId string

Campaign

period_type string

Period_type

period string

Period

status string

Status

institutionId string

Institution

value number

Value

payments number

Payments

bookings number

Bookings

]

Responses

200

Updated Broker

application/json

Schema

Schema

name string

Name

tags string

Tags

type string

Type

Possible values: [Broker, Agent, Agency, Consultant, Other]

firstName string

First Name

lastName string

Last Name

email string

Email

phone string

Phone

id string

Id

clientId string

Broker ID

members number

Members

institutions number

Companies

bookings number

Bookings

totalSpend number

Total

createdAt string

Created At

updatedAt string

Updated At

deletedAt string

Deleted At

deleted string

Deleted

createdBy string

Created By

updatedBy string

Updated By

deletedBy string

Deleted By

Example (from schema)

{
  "name": "string",
  "tags": "string",
  "type": "Broker",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "phone": "string",
  "id": "string",
  "clientId": "string",
  "members": 0,
  "institutions": 0,
  "bookings": 0,
  "totalSpend": 0,
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string",
  "deleted": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "deletedBy": "string"
}

Loading...