WIwithfaye
Partner

Generate a new partner

Changed on

Generates a partner based on specified information (CreatePartnerDto)

post/v1/partner

Request

Headers

Authorizationstring

Bearer token

Request body

namestring required
type'consortium' | 'hostAgency' | 'agency' required

Type of partners

emailstring
accountManagerEmailstring required
primaryAdmEmailstring
statestring required
consortiumNamestring
externalIdstring
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 generated.

namestring required
type'consortium' | 'hostAgency' | 'agency' required

Type of partners

emailstring
accountManagerEmailstring required
primaryAdmEmailstring
statestring required
consortiumNamestring
externalIdstring
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

  • e016afb8fdb3Revision 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 generate removed and replaced with createPartner

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • e95f3723e41fRevision 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

      api operation id createPartner removed and replaced with generate

    • info

      added the new optional header request parameter Authorization