Sign in
Partner

Generate a new partner

Generates a partner based on specified information (CreatePartnerDto)

post/v1/partner

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

Changed in 2 of the 3 revisions of this API.47

  • e016afb8fdb325See the full diff
    • ▲

      the source request property type/format changed from string/ to object/

      request-property-type-changed

    • ▲

      the source response's property type/format changed from string/ to object/ for status 201

      response-property-type-changed

    • ○

      api operation id generate removed and replaced with createPartner

      api-operation-id-removed

    • ○

      added the new optional request property companySetting

      new-optional-request-property

    • ○

      added the new optional request property parentCompanyExternalId

      new-optional-request-property

    • ○

      added the optional property companySetting to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property parentCompanyExternalId to the response with the 201 status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e95f3723e41f22See the full diff
    • ▲

      the source request property type/format changed from object/ to string/

      request-property-type-changed

    • ▲

      the source response's property type/format changed from object/ to string/ for status 201

      response-property-type-changed

    • ○

      api operation id createPartner removed and replaced with generate

      api-operation-id-removed

    • ○

      added the new optional header request parameter Authorization

      new-optional-request-parameter