latestOpenAPI 3.0.02026-07-263403911.5 MB

135571434f6c

Addresses5

Agents5

Announcements2

Audits3

BillProfiles6

Bills8

Charges5

CommissionPlans2

Contacts6

ContactTypes5

Credits5

Csr1

CustomerRelationships4

Customers13

CustomersOptimized2

Deposits3

Fields1

Files7

IntegrationEntityType2

IntegrationKeyLink6

IntegrationSystem2

InventoryItem11

InventoryTypes6

Lrn2

Notes6

NoteTypes2

Orders5

OrderServiceProducts1

OrderServices1

PackageProducts6

Packages6

PaymentAccounts9

PaymentMethods2

Payments10

Processes2

ProcessPhases2

ProcessRoutes2

ProcessTasks2

ProductAllowances5

ProductGroups6

Products6

ProductTypes2

ProviderAccounts5

ProviderContacts2

Providers5

ReportCategories6

Reports4

RequestAddresses5

RequestContacts6

RequestProducts6

Requests12

RequestServices6

RequestStatuses2

RequestTemplates2

ServiceCommissions6

ServiceInventory2

ServiceProduct6

Services7

ServiceTypes3

SystemStatus1

TaskNotifiedUsers4

Tasks6

TaskSteps2

TaskTypes2

TicketJournals3

TicketProcesses2

Tickets6

UsagePlanGroupPlans6

UsagePlanGroups6

UsagePlanRates6

UsagePlans6

UserGroups2

Users2

ViewOrder1

WebhookReceivers7

WebhookSubscriptions6

Announcements

View announcement

Find a single announcement by ID.

get/v1/Announcements/{id}

Path parameters

idinteger required

Format - int32. ID of the announcement to view.

Response

OK

okboolean

announcement_idinteger

Primary identifier for this announcement.

created_datestring date-time

Date the announcement was created.

titlestring required

Title of the announcement.

body_htmlstring required

HTML body of the announcement.

enabledboolean required

Whether the announcement is currently enabled.

location'ALL' | 'AGENT_PORTAL' | 'CUSTOMER_PORTAL'

Location of the announcement.

file_idinteger

File ID attached to the announcement.