Partner

Update a partner

Changed on Jul 10, 2026

Updates a partner based on specified information (UpdatePartnerDto)

put/v1/partner

Request

Base URL
https://partnerapi.withfaye.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/withfaye/apis/faye-partner-sales-api/docs/v1/partner/put.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Authorizationstring

Bearer token

Request body

namestring

emailstring

accountManagerEmailstring

primaryAdmEmailstring

statestring

consortiumNamestring

externalIdstring required

sourceobject

The source of the data example: salesforce

team'west' | 'east' | 'midAmerica' | 'PM' | 'nonUS'

Team of the partner

partnerIdentifierstring

Partner Identifier

apiboolean

Flag indicating if this is an API partner

utm_sourcestring

UTM source for API partners

utm_mediumstring

UTM medium for API partners

insuranceProductsstring[]

defaultInsuranceProductstring

parentCompanyExternalIdstring

Response

The partner has been successfully updated.

namestring

emailstring

accountManagerEmailstring

primaryAdmEmailstring

statestring

consortiumNamestring

externalIdstring required

sourceobject

The source of the data example: salesforce

team'west' | 'east' | 'midAmerica' | 'PM' | 'nonUS'

Team of the partner

partnerIdentifierstring

Partner Identifier

apiboolean

Flag indicating if this is an API partner

utm_sourcestring

UTM source for API partners

utm_mediumstring

UTM medium for API partners

insuranceProductsstring[]

defaultInsuranceProductstring

parentCompanyExternalIdstring

Changes

Jul 10, 2026e016afb8fdb3 Revision changes
- breaking
  the request property type changed from string to object
- breaking
  the response's property type changed from string to object for status
- info
  api operation id update removed and replaced with updatePartner
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the non-success response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
Jul 9, 2026e95f3723e41f Revision changes
- breaking
  the request property type changed from object to string
- breaking
  the response's property type changed from object to string for status
- info
  added the new optional header request parameter Authorization

Operation history