Skip to main content
Version: v3

Changelog

2026-07-07​

Ad Publishing

GET /ad-publishing/facebook/pages​

  • added the new optional query request parameter after
  • added the new optional query request parameter limit
  • added the media type application/json for the response with the status 200

2026-06-26​

Opportunities

POST /opportunities/pipelines​

  • endpoint added

DELETE /opportunities/pipelines/{pipelineId}​

  • endpoint added

GET /opportunities/pipelines/{pipelineId}​

  • endpoint added

PUT /opportunities/pipelines/{pipelineId}​

  • endpoint added

2026-06-18​

Ad Publishing

GET /ad-publishing/facebook/campaigns/{campaignId}/publishing-progress​

Saas

GET /saas/allow-attach-rebilling/{locationId}​

  • endpoint added

2026-06-15​

Users

POST /users/​

  • ⚠️ added the new pipelines.create enum value to the scopes response property for the response status 201
  • added the new pipelines.create enum value to the request property scopes/items/
  • added the new pipelines.create enum value to the request property scopesAssignedToOnly/items/

GET /users/search​

  • ⚠️ added the new pipelines.create enum value to the users/items/scopes response property for the response status 200

POST /users/search/filter-by-email​

  • ⚠️ added the new pipelines.create enum value to the users/items/scopes response property for the response status 200

GET /users/{userId}​

  • ⚠️ added the new pipelines.create enum value to the scopes response property for the response status 200

PUT /users/{userId}​

  • ⚠️ added the new pipelines.create enum value to the scopes response property for the response status 200
  • added the new pipelines.create enum value to the request property scopes/items/
  • added the new pipelines.create enum value to the request property scopesAssignedToOnly/items/

2026-06-12​

Ad Publishing

GET /ad-publishing/facebook/reporting/list​

  • the query request parameter campaignId became optional

2026-06-11​

Brand Boards

GET /brand-boards/locations/{locationId}/brand-voices​

  • endpoint added

POST /brand-boards/locations/{locationId}/brand-voices​

  • endpoint added

DELETE /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId}​

  • endpoint added

GET /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId}​

  • endpoint added

PATCH /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId}​

  • endpoint added

POST /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId}/default​

  • endpoint added

GET /brand-boards/public/v1/locations/{locationId}/voices​

  • api path removed with deprecation

POST /brand-boards/public/v1/locations/{locationId}/voices​

  • api path removed with deprecation

DELETE /brand-boards/public/v1/locations/{locationId}/voices/{brandVoiceId}​

  • api path removed with deprecation

GET /brand-boards/public/v1/locations/{locationId}/voices/{brandVoiceId}​

  • api path removed with deprecation

PATCH /brand-boards/public/v1/locations/{locationId}/voices/{brandVoiceId}​

  • api path removed with deprecation

POST /brand-boards/public/v1/locations/{locationId}/voices/{brandVoiceId}/default​

  • api path removed with deprecation

Email Isv

POST /email/verify​

  • ⚠️ added #/components/schemas/EmailVerifiedV3ResponseDto, #/components/schemas/LeadConnectorRecommendationDto to the response body oneOf list for the response status 201
  • removed #/components/schemas/EmailVerifiedResponseDto from the response body oneOf list for the response status 201

Components​

  • removed the schema EmailVerifiedResponseDto
  • removed the schema LeadConnectorRecomandationDto
  • the component security scheme Agency-Access-Only was added
  • the component security scheme Location-Access-Only was added

Emails

GET /emails/builder​

  • api path removed with deprecation

POST /emails/builder​

  • api path removed with deprecation

POST /emails/builder/data​

  • api path removed with deprecation

DELETE /emails/builder/{locationId}/{templateId}​

  • api path removed with deprecation

PATCH /emails/builder/{templateId}​

  • api path removed with deprecation

GET /emails/campaigns/bulk-actions​

  • api path removed with deprecation

GET /emails/campaigns/workflows​

  • api path removed with deprecation

GET /emails/locations/{locationId}/campaigns/bulk-actions​

  • endpoint added

GET /emails/locations/{locationId}/campaigns/bulk-actions/{campaignId}​

  • endpoint added

GET /emails/locations/{locationId}/campaigns/emails​

  • endpoint added

POST /emails/locations/{locationId}/campaigns/emails​

  • endpoint added

DELETE /emails/locations/{locationId}/campaigns/emails/{campaignId}​

  • endpoint added

GET /emails/locations/{locationId}/campaigns/emails/{campaignId}​

  • endpoint added

PATCH /emails/locations/{locationId}/campaigns/emails/{campaignId}​

  • endpoint added

POST /emails/locations/{locationId}/campaigns/emails/{campaignId}/schedule​

  • endpoint added

GET /emails/locations/{locationId}/campaigns/stats/{source}/{sourceId}​

  • endpoint added

GET /emails/locations/{locationId}/campaigns/workflows​

  • endpoint added

GET /emails/locations/{locationId}/campaigns/workflows/{campaignId}​

  • endpoint added

GET /emails/locations/{locationId}/templates​

  • endpoint added

POST /emails/locations/{locationId}/templates​

  • endpoint added

POST /emails/locations/{locationId}/templates/folders​

  • endpoint added

POST /emails/locations/{locationId}/templates/import​

  • endpoint added

DELETE /emails/locations/{locationId}/templates/{templateId}​

  • endpoint added

GET /emails/locations/{locationId}/templates/{templateId}​

  • endpoint added

PATCH /emails/locations/{locationId}/templates/{templateId}​

  • endpoint added

GET /emails/public/v2/locations/{locationId}/campaigns/bulk-actions​

  • api path removed with deprecation

GET /emails/public/v2/locations/{locationId}/campaigns/bulk-actions/{campaignId}​

  • api path removed with deprecation

POST /emails/public/v2/locations/{locationId}/campaigns/email-campaign​

  • api path removed with deprecation

GET /emails/public/v2/locations/{locationId}/campaigns/emails​

  • api path removed with deprecation

GET /emails/public/v2/locations/{locationId}/campaigns/emails/{campaignId}​

  • api path removed with deprecation

GET /emails/public/v2/locations/{locationId}/campaigns/stats/{source}/{sourceId}​

  • api path removed with deprecation

GET /emails/public/v2/locations/{locationId}/campaigns/workflows​

  • api path removed with deprecation

GET /emails/public/v2/locations/{locationId}/campaigns/workflows/{campaignId}​

  • api path removed with deprecation

DELETE /emails/public/v2/locations/{locationId}/campaigns/{campaignId}​

  • api path removed with deprecation

PATCH /emails/public/v2/locations/{locationId}/campaigns/{campaignId}​

  • api path removed with deprecation

POST /emails/public/v2/locations/{locationId}/campaigns/{campaignId}/schedule​

  • api path removed with deprecation

GET /emails/public/v2/locations/{locationId}/templates​

  • api path removed with deprecation

POST /emails/public/v2/locations/{locationId}/templates​

  • api path removed with deprecation

POST /emails/public/v2/locations/{locationId}/templates/folders​

  • api path removed with deprecation

POST /emails/public/v2/locations/{locationId}/templates/import​

  • api path removed with deprecation

DELETE /emails/public/v2/locations/{locationId}/templates/{templateId}​

  • api path removed with deprecation

GET /emails/public/v2/locations/{locationId}/templates/{templateId}​

  • api path removed with deprecation

PATCH /emails/public/v2/locations/{locationId}/templates/{templateId}​

  • api path removed with deprecation

GET /emails/schedule​

  • api path removed with deprecation

GET /emails/stats/location/{locationId}/{source}/{sourceId}​

  • api path removed with deprecation

Opportunities

POST /opportunities/​

  • ⚠️ removed #/components/schemas/customFieldsInputStringSchema, #/components/schemas/customFieldsInputArraySchema, #/components/schemas/customFieldsInputObjectSchema from the customFields/items/ request property anyOf list

  • added #/components/schemas/customFieldsInputStringSchemaV3, #/components/schemas/customFieldsInputArraySchemaV3, #/components/schemas/customFieldsInputObjectSchemaV3 to the customFields/items/ request property anyOf list

GET /opportunities/search​

  • ⚠️ added the new required query request parameter locationId

  • ⚠️ deleted the query request parameter assigned_to

  • ⚠️ deleted the query request parameter contact_id

  • ⚠️ deleted the query request parameter location_id

  • ⚠️ deleted the query request parameter pipeline_id

  • ⚠️ deleted the query request parameter pipeline_stage_id

  • added the new optional query request parameter assignedTo

  • added the new optional query request parameter contactId

  • added the new optional query request parameter pipelineId

  • added the new optional query request parameter pipelineStageId

PUT /opportunities/{id}​

  • ⚠️ removed #/components/schemas/customFieldsInputStringSchema, #/components/schemas/customFieldsInputArraySchema, #/components/schemas/customFieldsInputObjectSchema from the customFields/items/ request property anyOf list

  • added #/components/schemas/customFieldsInputStringSchemaV3, #/components/schemas/customFieldsInputArraySchemaV3, #/components/schemas/customFieldsInputObjectSchemaV3 to the customFields/items/ request property anyOf list

Components​

  • removed the schema CreateDto
  • removed the schema UpdateOpportunityDto
  • removed the schema customFieldsInputArraySchema
  • removed the schema customFieldsInputObjectSchema
  • removed the schema customFieldsInputStringSchema

Users

GET /users/​

  • api removed with deprecation

DELETE /users/{userId}​

  • ⚠️ added the new required header request parameter Version
  • ⚠️ removed the optional property succeded from the response with the 200 status
  • added the optional property succeeded to the response with the 200 status

Components​

  • removed the schema DeleteUserSuccessfulResponseDto

Contacts

GET /contacts/​

  • api removed with deprecation

POST /contacts/​

  • ⚠️ added #/components/schemas/DndSettingsSchemaV3 to the dndSettings request property allOf list
  • ⚠️ removed #/components/schemas/DndSettingsSchema from the dndSettings request property allOf list
  • added #/components/schemas/GetContactByIdSchemaV3 to the contact response property allOf list for the response status 201
  • removed #/components/schemas/CreateContactSchema from the contact response property allOf list for the response status 201

POST /contacts/upsert​

  • ⚠️ added #/components/schemas/DndSettingsSchemaV3 to the dndSettings request property allOf list
  • ⚠️ removed #/components/schemas/DndSettingsSchema from the dndSettings request property allOf list
  • added #/components/schemas/GetContactByIdSchemaV3 to the contact response property allOf list for the response status 200
  • removed #/components/schemas/GetContectByIdSchema from the contact response property allOf list for the response status 200

GET /contacts/{contactId}​

  • added #/components/schemas/GetContactByIdSchemaV3 to the contact response property allOf list for the response status 200
  • removed #/components/schemas/GetContectByIdSchema from the contact response property allOf list for the response status 200

PUT /contacts/{contactId}​

  • ⚠️ added #/components/schemas/DndSettingsSchemaV3 to the dndSettings request property allOf list
  • ⚠️ removed #/components/schemas/DndSettingsSchema from the dndSettings request property allOf list
  • ⚠️ removed the optional property succeded from the response with the 200 status
  • added #/components/schemas/GetContactByIdSchemaV3 to the contact response property allOf list for the response status 200
  • removed #/components/schemas/GetContectByIdSchema from the contact response property allOf list for the response status 200

DELETE /contacts/{contactId}/campaigns/remove-all​

  • endpoint added

DELETE /contacts/{contactId}/campaigns/removeAll​

  • api path removed with deprecation

Components​

  • removed the schema ContactsByIdSuccessfulResponseDto
  • removed the schema CreateContactDto
  • removed the schema CreateContactSchema
  • removed the schema CreateContactsSuccessfulResponseDto
  • removed the schema DndSettingsSchema
  • removed the schema GetContectByIdSchema
  • removed the schema UpdateContactDto
  • removed the schema UpdateContactsSuccessfulResponseDto
  • removed the schema UpsertContactDto
  • removed the schema UpsertContactsSuccessfulResponseDto

Oauth

GET /oauth/installed-locations​

  • endpoint added

GET /oauth/installedLocations​

  • ⚠️ api path removed without deprecation

POST /oauth/location-token​

  • endpoint added

POST /oauth/locationToken​

  • ⚠️ api path removed without deprecation

POST /oauth/token​

  • ⚠️ added the new required header request parameter Version
  • ⚠️ added the new required request property clientId
  • ⚠️ added the new required request property clientSecret
  • ⚠️ added the new required request property grantType
  • ⚠️ removed the request property client_id
  • ⚠️ removed the request property client_secret
  • ⚠️ removed the request property grant_type
  • ⚠️ removed the request property redirect_uri
  • ⚠️ removed the request property refresh_token
  • ⚠️ removed the request property user_type
  • ⚠️ removed the optional property access_token from the response with the 200 status
  • ⚠️ removed the optional property expires_in from the response with the 200 status
  • ⚠️ removed the optional property refresh_token from the response with the 200 status
  • ⚠️ removed the optional property token_type from the response with the 200 status
  • added the new optional request property redirectUri
  • added the new optional request property refreshToken
  • added the new optional request property userType
  • added the media type application/json to the request body
  • added the optional property accessToken to the response with the 200 status
  • added the optional property expiresIn to the response with the 200 status
  • added the optional property refreshToken to the response with the 200 status
  • added the optional property tokenType to the response with the 200 status

Components​

  • removed the schema GetAccessCodeSuccessfulResponseDto
  • removed the schema GetAccessCodebodyDto

Phone System

GET /phone-system/numbers/location/{locationId}​

  • ⚠️ added the new required header request parameter version

  • added the new optional query request parameter page

  • added the new optional query request parameter pageSize

  • added the media type application/json for the response with the status 200

POST /phone-system/numbers/location/{locationId}/purchase​

  • ⚠️ added the new required header request parameter version

  • added the media type application/json for the response with the status 201