# Reference ## Brands
client.brands.autofill({ ...params }) -> Pinnacle.OptionalBrandInfo
#### 📝 Description
Automatically populate brand information based on partial input data you provide.
#### 🔌 Usage
```typescript await client.brands.autofill({ additional_info: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.", name: "Pinnacle", options: { forceReload: true }, website: "https://www.pinnacle.sh" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.AutofillBrandParams`
**requestOptions:** `Brands.RequestOptions`
client.brands.upsert({ ...params }) -> Pinnacle.ExtendedBrand
#### 📝 Description
Create a new brand or update an existing one. **To create a new brand:** Omit `id` — one will be generated automatically. All fields are **required** except `description` and `dba`, and will be validated when [submitted](/api-reference/brands/submit).
#### 🔌 Usage
```typescript await client.brands.upsert({ address: "500 Folsom St, San Francisco, CA 94105", contact: { email: "michael.chen@trypinnacle.app", name: "Michael Chen", phone: "+14155551234", title: "Customer Support Representative" }, dba: "Pinnacle RCS", description: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.", ein: "88-1234567", email: "founders@trypinnacle.app", id: "b_1234567890", name: "Pinnacle", sector: "TECHNOLOGY", type: "PRIVATE_PROFIT", entityType: "LLC", website: "https://www.pinnacle.sh" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.UpsertBrandParams`
**requestOptions:** `Brands.RequestOptions`
client.brands.get(id, { ...params }) -> Pinnacle.ExtendedBrandWithVetting
#### 📝 Description
Retrieve detailed information for a specific brand in your account by ID.
#### 🔌 Usage
```typescript await client.brands.get("b_1234567890"); ```
#### ⚙️ Parameters
**id:** `string` The unique identifier of the brand you want to retrieve from your account.

This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
**request:** `Pinnacle.BrandsGetRequest`
**requestOptions:** `Brands.RequestOptions`
client.brands.submit(brandId) -> Pinnacle.SubmissionResults
#### 📝 Description
Submit your brand for review and approval by the compliance team.
#### 🔌 Usage
```typescript await client.brands.submit("b_1234567890"); ```
#### ⚙️ Parameters
**brandId:** `string` The unique identifier of the brand you want to submit for review.

This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890` and must correspond to an existing brand in your account that is ready for submission.
**requestOptions:** `Brands.RequestOptions`
client.brands.validate({ ...params }) -> Pinnacle.ValidationResults
#### 📝 Description
Validate your brand information for compliance and correctness before submission or storage.
#### 🔌 Usage
```typescript await client.brands.validate({}); ```
#### ⚙️ Parameters
**request:** `Pinnacle.OptionalBrandInfo`
**requestOptions:** `Brands.RequestOptions`
client.brands.vet(brandId, { ...params }) -> Pinnacle.VettingResults
#### 📝 Description
Submit a brand for external vetting verification to enhance your brand's trust score and improved message delivery rates.
#### 🔌 Usage
```typescript await client.brands.vet("b_1234567890", {}); ```
#### ⚙️ Parameters
**brandId:** `string` The unique identifier of the brand to vet.
This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890` and must correspond to an existing brand in your account that is ready for vetting.
**request:** `Pinnacle.VetBrandParams`
**requestOptions:** `Brands.RequestOptions`
client.brands.list({ ...params }) -> Pinnacle.ListBrandsResponse
#### 📝 Description
List all brands with optional filtering and pagination. Results are sorted by creation date, newest first.
#### 🔌 Usage
```typescript await client.brands.list(); ```
#### ⚙️ Parameters
**request:** `Pinnacle.ListBrandsParams`
**requestOptions:** `Brands.RequestOptions`
## Audiences
client.audiences.get({ ...params }) -> Pinnacle.AudiencesGetResponse
#### 📝 Description
Retrieve an audience by ID with optional pagination.
#### 🔌 Usage
```typescript await client.audiences.get({ id: "aud_abc123" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.AudiencesGetRequest`
**requestOptions:** `Audiences.RequestOptions`
client.audiences.create({ ...params }) -> Pinnacle.AudienceCountOnly
#### 📝 Description
Create a new audience with optional initial contacts. Phone numbers that don't exist will be auto-created as contacts.
#### 🔌 Usage
```typescript await client.audiences.create({ name: "Marketing Campaign Q1", description: "Contacts for Q1 marketing push" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.CreateAudienceParams`
**requestOptions:** `Audiences.RequestOptions`
client.audiences.delete({ ...params }) -> Pinnacle.DeleteAudienceResponse
#### 📝 Description
Permanently delete an audience and all its contact associations. Note: This will NOT delete the contacts themselves, only the audience and its memberships.
#### 🔌 Usage
```typescript await client.audiences.delete({ id: "aud_abc123" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.AudiencesDeleteRequest`
**requestOptions:** `Audiences.RequestOptions`
client.audiences.update({ ...params }) -> Pinnacle.AudienceCountOnly
#### 📝 Description
Update audience metadata. This endpoint does NOT modify contacts. To add or remove contacts, use the [Add Contacts](/api-reference/audiences/add-contacts) or [Remove Contacts](/api-reference/audiences/remove-contacts) endpoints.
#### 🔌 Usage
```typescript await client.audiences.update({ id: "aud_abc123", name: "Updated Audience Name", description: "New description" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.UpdateAudienceParams`
**requestOptions:** `Audiences.RequestOptions`
client.audiences.list({ ...params }) -> Pinnacle.ListAudiencesResponse
#### 📝 Description
List all audiences with optional filtering and pagination. Results are sorted by creation date, newest first.
#### 🔌 Usage
```typescript await client.audiences.list(); ```
#### ⚙️ Parameters
**request:** `Pinnacle.ListAudiencesParams`
**requestOptions:** `Audiences.RequestOptions`
## Contacts
client.contacts.get({ ...params }) -> Pinnacle.Contact
#### 📝 Description
Retrieve contact information for a given number.
#### 🔌 Usage
```typescript await client.contacts.get({ id: "co_1234567890" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.ContactsGetRequest`
**requestOptions:** `Contacts.RequestOptions`
client.contacts.create({ ...params }) -> Pinnacle.ContactId
#### 📝 Description
Create a new contact for a given phone number.
#### 🔌 Usage
```typescript await client.contacts.create({ phoneNumber: "phoneNumber" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.CreateContactParams`
**requestOptions:** `Contacts.RequestOptions`
client.contacts.update({ ...params }) -> Pinnacle.UpdatedContactId
#### 📝 Description
Update an existing contact.
#### 🔌 Usage
```typescript await client.contacts.update({ description: "Retired", email: "alvaroopedtech@pinnacle.sh", name: "Retired Bestie", tags: ["friend"], id: "co_1234567890" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.UpdateContactParams`
**requestOptions:** `Contacts.RequestOptions`
client.contacts.list({ ...params }) -> Pinnacle.ListContactsResponse
#### 📝 Description
List all contacts with optional filtering and pagination. Results are sorted by creation date, newest first.
#### 🔌 Usage
```typescript await client.contacts.list(); ```
#### ⚙️ Parameters
**request:** `Pinnacle.ListContactsParams`
**requestOptions:** `Contacts.RequestOptions`
## Conversations
client.conversations.get({ ...params }) -> Pinnacle.Conversation | null
#### 📝 Description
Fetch a specific conversation using either its unique identifier or by matching sender and recipient details.
#### 🔌 Usage
```typescript await client.conversations.get({ id: "conv_1234567890" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.GetConversationParams`
**requestOptions:** `Conversations.RequestOptions`
client.conversations.list({ ...params }) -> Pinnacle.ConversationList
#### 📝 Description
Retrieves conversations by page with optional filtering based off provided parameters.
#### 🔌 Usage
```typescript await client.conversations.list({ brandId: "b_1234567890", campaignId: "tf_1234567890", campaignType: "TOLL_FREE", pageIndex: 0, pageSize: 20, receiver: "+16509231662", sender: "+18445551234" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.ListConversationsParams`
**requestOptions:** `Conversations.RequestOptions`
client.conversations.update({ ...params }) -> Pinnacle.SuccessfulConversationUpdate
#### 📝 Description
Update the notes associated with a specific conversation.
#### 🔌 Usage
```typescript await client.conversations.update({ id: "conv_1234567890", notes: "Follow-up completed. Customer satisfied with resolution." }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.UpdateConversationParams`
**requestOptions:** `Conversations.RequestOptions`
client.conversations.listMessages(id, { ...params }) -> Pinnacle.MessageList
#### 📝 Description
Retrieve a paginated and filtered list of messages for a specific conversation.
#### 🔌 Usage
```typescript await client.conversations.listMessages("id"); ```
#### ⚙️ Parameters
**id:** `string` — Unique identifier of the conversation. This identifier is a string that always begins with the prefix `conv_`, for example: `conv_1234567890`.
**request:** `Pinnacle.ConversationsListMessagesRequest`
**requestOptions:** `Conversations.RequestOptions`
## Messages
client.messages.get(id) -> Pinnacle.Message
#### 📝 Description
Retrieve a previously sent message.
#### 🔌 Usage
```typescript await client.messages.get("msg_1234567890"); ```
#### ⚙️ Parameters
**id:** `string` — Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`.
**requestOptions:** `Messages.RequestOptions`
client.messages.react({ ...params }) -> Pinnacle.ReactionResult
#### 📝 Description
Add or remove an emoji reaction to a previously sent message.
#### 🔌 Usage
```typescript await client.messages.react({ messageId: "msg_1234567890", options: { force: true }, reaction: "\uD83D\uDC4D" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.ReactMessageParams`
**requestOptions:** `Messages.RequestOptions`
client.messages.list({ ...params }) -> Pinnacle.ListMessagesResponse
#### 📝 Description
List all messages with optional filtering and pagination. Results are sorted by creation date, newest first.
#### 🔌 Usage
```typescript await client.messages.list(); ```
#### ⚙️ Parameters
**request:** `Pinnacle.ListMessagesParams`
**requestOptions:** `Messages.RequestOptions`
## PhoneNumbers
client.phoneNumbers.search({ ...params }) -> Pinnacle.PhoneNumberDetails[]
#### 📝 Description
Search for available phone numbers that match your exact criteria.
#### 🔌 Usage
```typescript await client.phoneNumbers.search({ features: ["SMS", "MMS"], location: { city: "New York", nationalDestinationCode: "212" }, number: { contains: "514", startsWith: "45" }, options: { limit: 4 }, type: ["LOCAL"] }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.SearchPhoneNumberParams`
**requestOptions:** `PhoneNumbers.RequestOptions`
client.phoneNumbers.buy({ ...params }) -> Pinnacle.PurchasedNumber[]
#### 📝 Description
Purchase one or more phone numbers found through the [search endpoint](./search).
Billing uses your account credits and the numbers are ready for immediate use.
#### 🔌 Usage
```typescript await client.phoneNumbers.buy({ numbers: ["+18559491727"] }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.BuyPhoneNumberParams`
**requestOptions:** `PhoneNumbers.RequestOptions`
client.phoneNumbers.get({ ...params }) -> Pinnacle.PhoneNumbersGetResponse
#### 📝 Description
Retrieve information about any phone number.
#### 🔌 Usage
```typescript await client.phoneNumbers.get({ phone: "+11234567890", level: "advanced", options: { risk: true, enhanced_contact_info: { context: "This is my friend from JZ. He has done a lot in the crypto space." } } }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.RetrievePhoneNumberDetailsParams`
**requestOptions:** `PhoneNumbers.RequestOptions`
client.phoneNumbers.list({ ...params }) -> Pinnacle.ListPhoneNumbersResponse
#### 📝 Description
List all owned phone numbers with pagination. Results are sorted by creation date, newest first.
#### 🔌 Usage
```typescript await client.phoneNumbers.list(); ```
#### ⚙️ Parameters
**request:** `Pinnacle.ListPhoneNumbersParams`
**requestOptions:** `PhoneNumbers.RequestOptions`
## Rcs
client.rcs.getAgent(agentId) -> Pinnacle.RcsAgentResponse
#### 📝 Description
Retrieve details of an RCS agent by its ID. Returns the agent's configuration including display name, description, logo, hero image, contact information, and other settings.
#### 🔌 Usage
```typescript await client.rcs.getAgent("agent_abc123def456"); ```
#### ⚙️ Parameters
**agentId:** `string` — The RCS agent ID (must be prefixed with `agent_`).
**requestOptions:** `Rcs.RequestOptions`
client.rcs.getCapabilities({ ...params }) -> Pinnacle.RcsCapabilitiesResult
#### 📝 Description
Check RCS capabilities for one or more phone numbers. This endpoint allows you to verify which RCS features (cards, buttons, etc.) are supported on specific phone numbers before sending RCS messages to them.
#### 🔌 Usage
```typescript await client.rcs.getCapabilities({ phoneNumbers: ["+12345678901", "+19876543210"] }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.RcsCapabilitiesQuery`
**requestOptions:** `Rcs.RequestOptions`
client.rcs.getLink({ ...params }) -> Pinnacle.RcsLinkResult
#### 📝 Description
Generate a link for initiating an RCS conversation with your agent. Users can click these links to start conversations with your RCS agent directly from websites, emails, or other applications.
#### 🔌 Usage
```typescript await client.rcs.getLink({ agentId: "agent_XXXXXXXXXXXX", phoneNumber: "+12345678901", body: "Hello, I need help with my order" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.RcsLinkRequest`
**requestOptions:** `Rcs.RequestOptions`
## Webhooks
client.webhooks.get({ ...params }) -> Pinnacle.WebhookResult
#### 📝 Description
Retrieve all webhook that are set up to receive events for specific URLs or phone numbers.
#### 🔌 Usage
```typescript await client.webhooks.get({ identifiers: ["https://www.pinnacle.sh/payment", "+14155678901", "https://www.pinnacle.sh/sms-callback", "+14153456659"] }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.GetWebhookParams`
**requestOptions:** `Webhooks.RequestOptions`
client.webhooks.list({ ...params }) -> Pinnacle.ListWebhooksResponse
#### 📝 Description
List all webhooks with optional filtering and pagination. Results are sorted by creation date, newest first.
#### 🔌 Usage
```typescript await client.webhooks.list(); ```
#### ⚙️ Parameters
**request:** `Pinnacle.ListWebhooksParams`
**requestOptions:** `Webhooks.RequestOptions`
client.webhooks.attach({ ...params }) -> Pinnacle.AttachWebhookResult
#### 📝 Description
Attach a webhook to one or more senders (phone numbers or RCS agent IDs) to receive real-time event notifications.
You can attach an existing webhook by providing its ID, or create a new webhook by specifying a name and URL. Supports bulk operations with up to 50 senders per request.
Subscriptions are additive — attaching new senders does not remove existing ones. Re-attaching the same sender updates the event type filter without creating duplicates.
**Custom headers** may be provided in either case via the optional `headers` field. When attaching a new webhook, the headers are stored on the webhook and sent on every delivery. When attaching an existing `webhookId`, supplying `headers` **overwrites** the stored headers on that webhook — omit the field to leave them unchanged, or pass an empty object `{}` to clear them. The reserved `PINNACLE-SIGNING-SECRET` header is always set by Pinnacle and cannot be overridden.
#### 🔌 Usage
```typescript await client.webhooks.attach({ senders: ["+14155551234", "agent_abc123"] }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.AttachWebhookParams`
**requestOptions:** `Webhooks.RequestOptions`
client.webhooks.detach({ ...params }) -> Pinnacle.DetachWebhookResult
#### 📝 Description
Detach a webhook from one or more senders (phone numbers or RCS agent IDs) to stop receiving event notifications.
The webhook itself is not deleted and remains available for use with other senders. Works regardless of webhook status. Supports bulk operations with up to 50 senders per request.
#### 🔌 Usage
```typescript await client.webhooks.detach({ webhookId: "webhookId", senders: ["+14155551234", "agent_abc123"] }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.DetachWebhookParams`
**requestOptions:** `Webhooks.RequestOptions`
## Forms
client.forms.get(id) -> Pinnacle.Form
#### 📝 Description
Retrieve a form by id. Includes submission count, last submission timestamp, and archive state.
#### 🔌 Usage
```typescript await client.forms.get("form_Oy2n7iUoi9CJwUU6"); ```
#### ⚙️ Parameters
**id:** `string` The unique identifier of the form you want to retrieve.

This identifier is a string that always begins with the prefix `form_`, for example: `form_Oy2n7iUoi9CJwUU6`. It's returned on every form response (`Form.id`) and by [`POST /forms/send`](/api-reference/forms/send-form) (`response.form.id`).
**requestOptions:** `Forms.RequestOptions`
client.forms.update(id, { ...params }) -> Pinnacle.Form
#### 📝 Description
Partial update. Only keys present in the body are applied. Archived forms (non-null `archived_at`) cannot be updated — restore the form by setting `archived_at: null` in a PATCH first.
#### 🔌 Usage
```typescript await client.forms.update("form_Oy2n7iUoi9CJwUU6", { name: "Contact request (v2)", can_update: true, expires_at: "2026-12-31T23:59:59Z" }); ```
#### ⚙️ Parameters
**id:** `string` The unique identifier of the form you want to update.

This identifier is a string that always begins with the prefix `form_`, for example: `form_Oy2n7iUoi9CJwUU6`.
**request:** `Pinnacle.UpdateFormParams`
**requestOptions:** `Forms.RequestOptions`
client.forms.list({ ...params }) -> Pinnacle.ListFormsResponse
#### 📝 Description
Paginated list of forms on your team, sorted by creation date (newest first). Includes archived forms.
#### 🔌 Usage
```typescript await client.forms.list({ pageIndex: 0, pageSize: 20 }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.ListFormsParams`
**requestOptions:** `Forms.RequestOptions`
client.forms.create({ ...params }) -> Pinnacle.Form
#### 📝 Description
Create a hosted form without sending it.
Returns the form object including its public URL — `https://forms.pinnacle.sh/{form_id}`.
To also deliver the URL to a recipient over SMS or RCS in a single call, use [`POST /forms/send`](/api-reference/forms/send-form).
#### 🔌 Usage
```typescript await client.forms.create({ name: "Contact request", description: "We'll follow up over SMS or RCS.", fields: [{ type: "text", key: "full_name", label: "Full name", required: true, placeholder: "Ada Lovelace", min_length: 2, max_length: 60 }, { type: "email", key: "email", label: "Email", required: true, placeholder: "you@example.com" }, { type: "phone", key: "phone", label: "Phone", required: true, placeholder: "(555) 555-1212" }, { type: "select", key: "plan", label: "Plan", required: true, options: [{ value: "basic", label: "Basic" }, { value: "pro", label: "Pro" }, { value: "enterprise", label: "Enterprise" }] }], can_update: false }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.CreateFormRequest`
**requestOptions:** `Forms.RequestOptions`
client.forms.send({ ...params }) -> Pinnacle.FormsSendResponse
#### 📝 Description
Send a form to a recipient over SMS or RCS, or mint a standalone submission URL. Pass `form` as either an existing form id (`form_*`) or an inline `{ fields, ... }` definition to mint a new form for this send. The delivery channel is inferred from `from`: - `from: "agent_*"` → RCS (with optional SMS `fallback`) - `from: "+E.164"` → SMS When `to` is provided, Pinnacle dispatches a message whose body contains the submission URL and the recipient is recorded on the response: `submission.to` echoes the same E.164 number and `message_id` is the id of the outbound SMS/RCS. When `to` is omitted, no message is sent — `submission.to` and `message_id` are both `null` — which is useful for embedding the URL in your own outreach. On completion, a `FORM.SUBMISSION` webhook event is delivered to webhooks subscribed to the sender. See [Receiving Messages and User Events](/guides/messages/receiving).
#### 🔌 Usage
```typescript await client.forms.send({ from: "agent_iM9wQcyBBjYn", to: "+14155551234", form: "form_Oy2n7iUoi9CJwUU6", fallback: { from: "+14155550000" }, options: { webview_mode: "FULL" } }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.SendFormParams`
**requestOptions:** `Forms.RequestOptions`
## Audiences Contacts
client.audiences.contacts.remove({ ...params }) -> Pinnacle.AudienceCountOnly
#### 📝 Description
Remove contacts from an existing audience. This operation is idempotent. - Only removes contacts that exist in the audience - Contacts not in the audience are ignored
#### 🔌 Usage
```typescript await client.audiences.contacts.remove({ id: "aud_abc123", contacts: ["+12125551234", "co_def456"] }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.audiences.RemoveContactsParams`
**requestOptions:** `Contacts.RequestOptions`
client.audiences.contacts.add({ ...params }) -> Pinnacle.AudienceCountOnly
#### 📝 Description
Add contacts to an existing audience. This operation is additive and idempotent. - Phone numbers that don't exist will be auto-created as contacts - Duplicate adds are ignored - Contacts already in the audience are ignored
#### 🔌 Usage
```typescript await client.audiences.contacts.add({ id: "aud_abc123", contacts: ["+12125551234", "co_def456", "+13105551234"] }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.audiences.AddContactsParams`
**requestOptions:** `Contacts.RequestOptions`
## Campaigns Dlc
client.campaigns.dlc.autofill({ ...params }) -> Pinnacle.AutofillDlcCampaignResponse
#### 📝 Description
Generate campaign details based off existing campaign and the brand it's connected to.
#### 🔌 Usage
```typescript await client.campaigns.dlc.autofill({ additionalInfo: "Please autofill missing campaign fields using my brand profile", campaignId: "dlc_1234567890" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.AutofillCampaignParams`
**requestOptions:** `Dlc.RequestOptions`
client.campaigns.dlc.get(campaignId) -> Pinnacle.DlcCampaignWithExtendedBrandAndStatus
#### 📝 Description
Retrieve 10DLC campaign.
#### 🔌 Usage
```typescript await client.campaigns.dlc.get("dlc_1234567890"); ```
#### ⚙️ Parameters
**campaignId:** `string` — Unique identifier of the 10DLC campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
**requestOptions:** `Dlc.RequestOptions`
client.campaigns.dlc.submit(campaignId) -> Pinnacle.CampaignSubmissionResult
#### 📝 Description
Submit your 10DLC campaign for approval and activation with carriers.
#### 🔌 Usage
```typescript await client.campaigns.dlc.submit("dlc_1234567890"); ```
#### ⚙️ Parameters
**campaignId:** `string` Unique identifier of the 10DLC campaign to submit.

This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
**requestOptions:** `Dlc.RequestOptions`
client.campaigns.dlc.upsert({ ...params }) -> Pinnacle.DlcCampaignWithExtendedBrandAndStatus
#### 📝 Description
Create a new 10DLC campaign or update an existing one. **To create a new campaign:** Omit `campaignId` — one will be generated automatically. **Before you start:** Create a [brand](/api-reference/brands/upsert) first — you'll need its `id` for the [`brand`](#request.body.brand) field. All fields are **required** unless specified otherwise, and will be validated when [submitted](/api-reference/campaigns/10-dlc/submit). **See the response for example values for each field.**
#### 🔌 Usage
```typescript await client.campaigns.dlc.upsert({ autoRenew: true, brand: "b_1234567890", description: "This campaign sends transactional SMS messages to customers who have opted in, including account notifications, security alerts, and customer care responses. Messages are sent when triggered by account activity such as login attempts, password changes, order updates, or support inquiries. All messages include required STOP/HELP disclosures and comply with TCPA guidelines.", keywords: { HELP: { message: "Pinnacle Software Development Inc.: For assistance, visit https://pinnacle.sh/support or email founders@trypinnacle.app. Msg&data rates may apply. Reply STOP to cancel.", values: ["HELP", "SUPPORT", "INFO"] }, OPT_IN: { message: "Pinnacle Software Development Inc.: You're enrolled in account & security alerts. Msg&data rates may apply. Message frequency varies. Reply HELP for help, STOP to cancel. Terms: https://pinnacle.sh/terms Privacy: https://pinnacle.sh/privacy", values: ["START", "YES", "SUBSCRIBE"] }, OPT_OUT: { message: "Pinnacle Software Development Inc.: You're unsubscribed and will receive no further texts. For assistance, visit https://pinnacle.sh or call 877-389-0460. Reply START to resubscribe.", values: ["STOP", "CANCEL", "UNSUBSCRIBE"] } }, links: { privacyPolicy: "https://www.pinnacle.sh/privacy", termsOfService: "https://www.pinnacle.sh/terms" }, messageFlow: "The user fills out a paper form during onboarding at [Address] which they learn about at our website (https://pinnacle.sh) in which they provide their phone number and sign their consent. The form includes a disclaimer: \"By signing this form and providing your phone number, you agree to receive SMS Mixed - Account Notification, Customer Care, Security Alert, Delivery Notification from Pinnacle Software Development Inc. Message frequency may vary. Standard Message and Data Rates may apply. Reply STOP to opt out. Reply HELP for help. Consent is not a condition of purchase. Your mobile information will not be sold or shared with third parties for promotional or marketing purposes.\" Once the information is entered into the system, the user receives a confirmation SMS: \"Thank you for signing up for SMS updates from Pinnacle Software Development Inc. Msg freq may vary. Std msg & data rates apply. Reply STOP to opt out, HELP for help.\" Link to paper form: https://www.pinnacle.sh/opt-in", name: "Pinnacle's Account Notifications", options: { affiliateMarketing: false, ageGated: false, directLending: false, embeddedLink: "https://www.pinnacle.sh/example", embeddedPhone: false, numberPooling: false }, sampleMessages: ["Pinnacle Software Development Inc.: We're here to help. Visit https://pinnacle.sh or call 877-389-0460. Msg&data rates may apply. Reply STOP to cancel.", "Pinnacle Software Development Inc.: You're enrolled in account & security alerts. Msg&data rates may apply. Message frequency varies. Reply HELP for help, STOP to cancel. Terms: https://pinnacle.sh/terms/ Privacy: https://pinnacle.sh/privacy/", "Pinnacle Software Development Inc.: An update has been made to your account. Read it in the portal.", "Pinnacle Software Development Inc.: We received your message. A team member will reply shortly. For immediate help call 877-389-0460. Msg&data rates may apply. Reply STOP to cancel."], useCase: { sub: ["ACCOUNT_NOTIFICATION", "CUSTOMER_CARE", "SECURITY_ALERT"], value: "MIXED" } }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.campaigns.UpsertDlcCampaignParams`
**requestOptions:** `Dlc.RequestOptions`
client.campaigns.dlc.validate({ ...params }) -> Pinnacle.CampaignValidationResult
#### 📝 Description
Validate your 10DLC campaign configuration against carrier requirements and compliance rules.
#### 🔌 Usage
```typescript await client.campaigns.dlc.validate({ additionalInfo: "Please validate this DLC campaign for 10DLC compliance", campaignId: "dlc_1234567890" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.ValidateCampaignParams`
**requestOptions:** `Dlc.RequestOptions`
client.campaigns.dlc.list({ ...params }) -> Pinnacle.ListDlcCampaignsResponse
#### 📝 Description
List all 10DLC campaigns with optional filtering and pagination. Results are sorted by creation date, newest first.
#### 🔌 Usage
```typescript await client.campaigns.dlc.list(); ```
#### ⚙️ Parameters
**request:** `Pinnacle.campaigns.ListDlcCampaignsParams`
**requestOptions:** `Dlc.RequestOptions`
## Campaigns TollFree
client.campaigns.tollFree.autofill({ ...params }) -> Pinnacle.TollFreeAutofillResponse
#### 📝 Description
Generate campaign details based off existing campaign and the brand it's connected to.
#### 🔌 Usage
```typescript await client.campaigns.tollFree.autofill({ additionalInfo: "Please autofill missing campaign fields using my brand profile", campaignId: "dlc_1234567890" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.AutofillCampaignParams`
**requestOptions:** `TollFree.RequestOptions`
client.campaigns.tollFree.get(campaignId) -> Pinnacle.TollFreeCampaignWithExtendedBrandAndStatus
#### 📝 Description
Retrieve Toll-Free campaign.
#### 🔌 Usage
```typescript await client.campaigns.tollFree.get("tf_1234567890"); ```
#### ⚙️ Parameters
**campaignId:** `string` — Unique identifier of toll-free campaign. Must begin with the prefix `tf_`.
**requestOptions:** `TollFree.RequestOptions`
client.campaigns.tollFree.submit(campaignId) -> Pinnacle.CampaignSubmissionResult
#### 📝 Description
Submit your toll-free campaign for approval and activation with carriers.
#### 🔌 Usage
```typescript await client.campaigns.tollFree.submit("tf_1234567890"); ```
#### ⚙️ Parameters
**campaignId:** `string` — Unique identifier of the toll-free campaign to submit. Must begin with the prefix `tf_`.
**requestOptions:** `TollFree.RequestOptions`
client.campaigns.tollFree.upsert({ ...params }) -> Pinnacle.TollFreeCampaignWithExtendedBrandAndStatus
#### 📝 Description
Create a new toll-free campaign or update an existing one. **To create a new campaign:** Omit `campaignId` — one will be generated automatically. **Before you start:** Create a [brand](/api-reference/brands/upsert) first — you'll need its `id` for the [`brand`](#request.body.brand) field. All fields are **required** unless specified otherwise, and will be validated when [submitted](/api-reference/campaigns/toll-free/submit). **See the response for example values for each field.**
#### 🔌 Usage
```typescript await client.campaigns.tollFree.upsert({ brand: "b_1234567890", campaignId: "tf_1234567890", keywords: { HELP: { message: "Pinnacle Software Development Inc.: For assistance, visit https://pinnacle.sh/support or email founders@trypinnacle.app. Msg&data rates may apply. Reply STOP to cancel." }, OPT_IN: { message: "Pinnacle Software Development Inc.: You're enrolled in account & security alerts. Msg&data rates may apply. Message frequency varies. Reply HELP for help, STOP to cancel. Terms: https://pinnacle.sh/terms/ Privacy: https://pinnacle.sh/privacy/", keywords: ["START", "SUBSCRIBE"] } }, links: { privacyPolicy: "https://www.pinnacle.sh/privacy", termsOfService: "https://www.pinnacle.sh/terms" }, monthlyVolume: "10,000", name: "Pinnacle", optIn: { method: "PAPER", url: "https://www.pinnacle.sh/opt-in", workflowDescription: "End users opt-in when filling out the in-person intake forms where they will write their phone numbers and check a box indicating that they've opted in to messages. Link to paper form: https://www.pinnacle.sh/opt-in" }, options: { ageGated: false }, productionMessageContent: "Hi [First Name], your order #[Order ID] has shipped and will arrive [Date]. Track here: [URL]. Reply HELP for help or STOP to unsubscribe.", useCase: { summary: "Customers who have opted into text messages can interact with our automated SMS chatbot to receive transaction-driven notifications (order status, shipping updates, account alerts), ask support questions, share photos with friends, and manage their account details via simple, conversational text flows. All messages are transactional or interactive flows customers opt into. Users can send images (e.g., receipts) and get guided replies.", value: "CHATBOT" } }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.campaigns.UpsertTollFreeCampaignParams`
**requestOptions:** `TollFree.RequestOptions`
client.campaigns.tollFree.validate({ ...params }) -> Pinnacle.CampaignValidationResult
#### 📝 Description
Validate your toll-free campaign configuration against carrier requirements and compliance rules.
#### 🔌 Usage
```typescript await client.campaigns.tollFree.validate({ additionalInfo: "Please validate this DLC campaign for 10DLC compliance", campaignId: "dlc_1234567890" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.ValidateCampaignParams`
**requestOptions:** `TollFree.RequestOptions`
client.campaigns.tollFree.list({ ...params }) -> Pinnacle.ListTollFreeCampaignsResponse
#### 📝 Description
List all toll-free campaigns with optional filtering and pagination. Results are sorted by creation date, newest first.
#### 🔌 Usage
```typescript await client.campaigns.tollFree.list(); ```
#### ⚙️ Parameters
**request:** `Pinnacle.campaigns.ListTollFreeCampaignsParams`
**requestOptions:** `TollFree.RequestOptions`
## Campaigns Rcs
client.campaigns.rcs.autofill({ ...params }) -> Pinnacle.RcsAutofillResponse
#### 📝 Description
Generate campaign details based off existing campaign and the brand it's connected to.
#### 🔌 Usage
```typescript await client.campaigns.rcs.autofill({ additionalInfo: "Please autofill missing campaign fields using my brand profile", campaignId: "dlc_1234567890" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.AutofillCampaignParams`
**requestOptions:** `Rcs.RequestOptions`
client.campaigns.rcs.get(campaignId) -> Pinnacle.ExtendedRcsCampaign
#### 📝 Description
Retrieve RCS campaign.
#### 🔌 Usage
```typescript await client.campaigns.rcs.get("rcs_1234567890"); ```
#### ⚙️ Parameters
**campaignId:** `string` — Unique identifier of the RCS campaign. Must begin with the prefix `rcs_`.
**requestOptions:** `Rcs.RequestOptions`
client.campaigns.rcs.submit(campaignId) -> Pinnacle.CampaignSubmissionResult
#### 📝 Description
Submit your RCS campaign for approval and activation with carriers.
#### 🔌 Usage
```typescript await client.campaigns.rcs.submit("rcs_1234567890"); ```
#### ⚙️ Parameters
**campaignId:** `string` — Unique identifier of the RCS campaign to retrieve. Must begin with the prefix `rcs_`.
**requestOptions:** `Rcs.RequestOptions`
client.campaigns.rcs.upsert({ ...params }) -> Pinnacle.ExtendedRcsCampaign
#### 📝 Description
Create a new RCS campaign or update an existing one. **To create a new campaign:** Omit `campaignId` — one will be generated automatically. **Before you start:** Create a [brand](/api-reference/brands/upsert) first — you'll need its `id` for the [`brand`](#request.body.brand) field. All fields are **required** unless specified otherwise, and will be validated when [submitted](/api-reference/campaigns/rcs/submit).
#### 🔌 Usage
```typescript await client.campaigns.rcs.upsert({ agent: { color: "#000000", description: "Experience the power of RCS messaging with interactive demos. Test rich features like carousels, suggested replies, and media sharing. Get started with our developer-friendly APIs.", emails: [{ email: "founders@trypinnacle.app", label: "Email Us" }], heroUrl: "https://pncl.to/D6pDSqGxqgfbCfQmw4gXdnlHu4uSB4", iconUrl: "https://pncl.to/mq_tdIDenRb5eYpJiM8-3THCaUBrZP", name: "Pinnacle - RCS Demo", phones: [{ label: "Contact us directly", phone: "+14154467821" }], websites: [{ label: "Get started with Pinnacle", url: "https://www.trypinnacle.app/" }] }, brand: "b_1234567890", campaignId: "rcs_1234567890", expectedAgentResponses: ["Here are the things I can help you with.", "I can assist you with booking an appointment, or you may choose to book manually.", "Here are the available times to connect with a representative tomorrow.", "Your appointment has been scheduled."], links: { privacyPolicy: "\u201Chttps://www.trypinnacle.app/privacy\u201D", termsOfService: "\u201Chttps://www.trypinnacle.app/terms\u201D" }, useCaseDescription: "Pinnacle is a developer-focused RCS assistant that helps teams design, test, and optimize rich messaging experiences across SMS, MMS, and RCS. The agent acts as both an \u201Conboarding guide\u201D for new customers and a \u201Cbest-practices coach\u201D for existing teams exploring higher-value RCS workflows like rich cards, carousels, and suggested actions.
\nThe agent delivers a mix of operational updates and educational content (2\u20136 messages/month). Content includes important platform notices (e.g., deliverability or throughput changes), implementation tips with sample RCS templates, and personalized recommendations on how to upgrade existing SMS campaigns into richer, higher-converting RCS conversations.\n", messagingType: "OTP", ctaMedia: "\u201Chttps://www.pinnacle.sh/send\u201D", optInMethod: "We ensure consent through an explicit opt-in process that follows 10DLC best practices.Users must agree to receive messages from Pinnacle before the agent sends them any messages.
\nUsers agree to these messages by signing an opt-in paper form that they can be found online at https://www.pinnacle.sh/opt-in. We only send messages once users have filled out the form and submitted it to us via email or through the dashboard.\n", keywords: { HELP: { message: "Email founders@trypinnacle.app for support.", keywords: ["HELP", "SUPPORT"] }, OPT_IN: { message: "Welcome back to Pinnacle!
\n\uD83D\uDD14 You're now subscribed to Pinnacle - RCS Demo and will continue receiving important updates and news. Feel free to contact this us at any time for help.
\n\nReply STOP to opt out and HELP for support. Message & rates may apply.\n", keywords: ["START", "SUBSCRIBE"] }, OPT_OUT: { message: "You've been unsubscribed from Pinnacle - RCS Demo and will no longer receive notifications. If you ever change your mind, reply START or SUBSCRIBE to rejoin anytime.", keywords: ["STOP", "UNSUBSCRIBE", "END"] } }, traffic: { monthlyWebsite: 10000, monthlyRcsEstimate: 10000 }, ctaLanguage: "By checking this box and submitting this form, you consent to receive transactional text messages for support, appointment, and reminder messages from Pinnacle Software Development Inc. Reply STOP to opt out. Reply HELP for help. Standard message and data rates may apply. Message frequency may vary. View our Terms and Conditions at https://www.pinnacle.sh/terms. View our Privacy Policy at https://www.pinnacle.sh/privacy.", demoTrigger: "Text \"START\" to trigger the flow." }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.campaigns.UpsertRcsCampaignParams`
**requestOptions:** `Rcs.RequestOptions`
client.campaigns.rcs.validate({ ...params }) -> Pinnacle.CampaignValidationResult
#### 📝 Description
Validate your RCS campaign configuration against carrier requirements and compliance rules.
#### 🔌 Usage
```typescript await client.campaigns.rcs.validate({ additionalInfo: "Please validate this DLC campaign for 10DLC compliance", campaignId: "dlc_1234567890" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.ValidateCampaignParams`
**requestOptions:** `Rcs.RequestOptions`
client.campaigns.rcs.list({ ...params }) -> Pinnacle.ListRcsCampaignsResponse
#### 📝 Description
List all RCS campaigns with optional filtering and pagination. Results are sorted by creation date, newest first.
#### 🔌 Usage
```typescript await client.campaigns.rcs.list(); ```
#### ⚙️ Parameters
**request:** `Pinnacle.campaigns.ListRcsCampaignsParams`
**requestOptions:** `Rcs.RequestOptions`
## Forms Submissions
client.forms.submissions.list(id, { ...params }) -> Pinnacle.ListFormSubmissionsResponse
#### 📝 Description
Paginated list of completed submissions for a form, newest first. Each row includes the submitted `data` keyed by field `key`, the sender/recipient, IP, user-agent, and timestamps.
#### 🔌 Usage
```typescript await client.forms.submissions.list("form_Oy2n7iUoi9CJwUU6", { pageIndex: 0, pageSize: 20 }); ```
#### ⚙️ Parameters
**id:** `string` The unique identifier of the form whose submissions you want to list.

This identifier is a string that always begins with the prefix `form_`, for example: `form_Oy2n7iUoi9CJwUU6`.
**request:** `Pinnacle.forms.ListFormSubmissionsParams`
**requestOptions:** `Submissions.RequestOptions`
## Messages Sms
client.messages.sms.send({ ...params }) -> Pinnacle.SmsSendResponse
#### 📝 Description
Send a SMS message immediately or schedule it for future delivery.
#### 🔌 Usage
```typescript await client.messages.sms.send({ from: "+14155164736", text: "Hey!", to: "+14154746461" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.messages.Sms`
**requestOptions:** `Sms.RequestOptions`
client.messages.sms.validate({ ...params }) -> Pinnacle.SmsValidationResult
#### 📝 Description
Validate SMS message content without sending it.
#### 🔌 Usage
```typescript await client.messages.sms.validate({ text: "Hello from Pinnacle" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.SmsContent`
**requestOptions:** `Sms.RequestOptions`
## Messages Mms
client.messages.mms.send({ ...params }) -> Pinnacle.MmsSendResponse
#### 📝 Description
Send a MMS immediately or schedule it for future delivery.
#### 🔌 Usage
```typescript await client.messages.mms.send({ from: "+14155164736", mediaUrls: ["https://fastly.picsum.photos/id/941/300/300.jpg?hmac=mDxM9PWSqRDjecwSCEpzU4bj35gqnG7yA25OL29uNv0"], options: { multiple_messages: true, validate: true }, text: "Check out this image!", to: "+14154746461" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.messages.Mms`
**requestOptions:** `Mms.RequestOptions`
client.messages.mms.validate({ ...params }) -> Pinnacle.MmsValidationResult
#### 📝 Description
Validate MMS message content without sending it.
#### 🔌 Usage
```typescript await client.messages.mms.validate({ mediaUrls: ["https://upload.wikimedia.org/wikipedia/commons/b/b9/Pizigani_1367_Chart_1MB.jpg", "https://fastly.picsum.photos/id/528/1000/1000.jpg?hmac=aTG0xNif9KbNryFN0ZNZ_nFK6aEpZxqUGCZF1KjOT8w", "https://file-examples.com/storage/fefdd7ab126835e7993bb1a/2017/10/file_example_JPG_500kB.jpg"], text: "Check out these images!" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.MmsContent`
**requestOptions:** `Mms.RequestOptions`
## Messages Rcs
client.messages.rcs.send({ ...params }) -> Pinnacle.SendRichMessageResponse
#### 📝 Description
Send a RCS message immediately or schedule it for future delivery.
Requires an active RCS agent and recipient devices that support RCS Business Messaging.
#### 🔌 Usage
```typescript await client.messages.rcs.send({ text: "text", from: "from", to: "to" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.RichMessage`
**requestOptions:** `Rcs.RequestOptions`
client.messages.rcs.sendTyping({ ...params }) -> Pinnacle.SendTypingIndicatorResponse
#### 📝 Description
Send a typing indicator from an RCS agent to a recipient. This endpoint allows RCS agents to display a typing indicator to recipients. The indicator is a message bubble with animated typing dots like this: Typing Indicator **Use Case:** Typing indicators are especially useful for providing feedback to users while the agent is thinking or generating a response that may take some time, creating a more engaging conversational experience. **Expiration:** Typing indicators automatically expire after around 20 seconds or when the agent sends a message, whichever comes first. **Frequency:** You can send typing indicators as many times as needed, though only one will be displayed at a time. Sending multiple typing indicators will extend the duration of the current indicator. > **Note:** Typing indicators are best-effort hints, not delivery-guaranteed state. The platform is allowed to coalesce or drop them, and the client UI decides when to show/hide.
#### 🔌 Usage
```typescript await client.messages.rcs.sendTyping({ agentId: "agent_pinnacle", to: "+14154746461" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.messages.SendTypingIndicatorSchema`
**requestOptions:** `Rcs.RequestOptions`
client.messages.rcs.validate({ ...params }) -> Pinnacle.RcsValidationResult
#### 📝 Description
Validate RCS message content without sending it.
#### 🔌 Usage
```typescript await client.messages.rcs.validate({ text: "text" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.RcsValidateContent`
**requestOptions:** `Rcs.RequestOptions`
## Messages Blast
client.messages.blast.sms({ ...params }) -> Pinnacle.BlastSmsResponse
#### 📝 Description
Send an SMS message to all contacts in an audience.
Messages are distributed evenly across the provided sender phone numbers.
Use the optional `schedule` parameter in `options` to schedule the blast for future delivery. When scheduled, the response will contain a `scheduleId` instead of blast details.
#### 🔌 Usage
```typescript await client.messages.blast.sms({ audienceId: "aud_abc123", senders: ["+14155164736", "+14155164737"], message: { text: "Hello from Pinnacle!" } }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.messages.BlastSms`
**requestOptions:** `Blast.RequestOptions`
client.messages.blast.mms({ ...params }) -> Pinnacle.BlastMmsResponse
#### 📝 Description
Send an MMS message to all contacts in an audience.
Messages are distributed evenly across the provided sender phone numbers.
Use the optional `schedule` parameter in `options` to schedule the blast for future delivery. When scheduled, the response will contain a `scheduleId` instead of blast details.
#### 🔌 Usage
```typescript await client.messages.blast.mms({ audienceId: "aud_abc123", senders: ["+14155164736", "+14155164737"], message: { mediaUrls: ["https://fastly.picsum.photos/id/941/300/300.jpg"], text: "Check out this image!" }, options: { validate: true } }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.messages.BlastMms`
**requestOptions:** `Blast.RequestOptions`
client.messages.blast.rcs({ ...params }) -> Pinnacle.BlastRcsResponse
#### 📝 Description
Send an RCS message to all contacts in an audience.
Messages are distributed evenly across the provided RCS agents for load balancing. Requires active RCS agents and recipient devices that support RCS Business Messaging.
Use the optional `schedule` parameter in `options` to schedule the blast for future delivery. When scheduled, the response will contain a `scheduleId` instead of blast details.
#### 🔌 Usage
```typescript await client.messages.blast.rcs({ audienceId: "aud_abc123", senders: ["agent_pinnacle", "agent_pinnacle2"], message: { quickReplies: [{ type: "trigger", payload: "payload", title: "title" }], text: "Hello from Pinnacle RCS!" }, fallback: { from: "+14155164736", text: "Hello from Pinnacle! Reply LEARN to learn more." }, options: { transcode: true, validate: true } }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.messages.BlastRcs`
**requestOptions:** `Blast.RequestOptions`
## Messages Schedule
client.messages.schedule.cancel(id) -> Pinnacle.ScheduleCancelResult
#### 📝 Description
Cancel a scheduled message or blast.
Works for both individual scheduled messages and scheduled blasts. Use the `scheduleId` returned when the message or blast was scheduled.
#### 🔌 Usage
```typescript await client.messages.schedule.cancel("id"); ```
#### ⚙️ Parameters
**id:** `string` — Unique identifier of the scheduled message. This identifier is a string that always begins with the prefix `msg_sched_`, for example: `msg_sched_1234567890`.
**requestOptions:** `Schedule.RequestOptions`
## Messages Schedules
client.messages.schedules.list({ ...params }) -> Pinnacle.ListScheduledMessagesResponse
#### 📝 Description
List all scheduled messages with optional filtering and pagination. Results are sorted by creation date, newest first.
#### 🔌 Usage
```typescript await client.messages.schedules.list(); ```
#### ⚙️ Parameters
**request:** `Pinnacle.messages.ListScheduledMessagesParams`
**requestOptions:** `Schedules.RequestOptions`
## Messages Blasts
client.messages.blasts.list({ ...params }) -> Pinnacle.ListBlastsResponse
#### 📝 Description
List all blasts with optional filtering and pagination. Results are sorted by creation date, newest first.
#### 🔌 Usage
```typescript await client.messages.blasts.list(); ```
#### ⚙️ Parameters
**request:** `Pinnacle.messages.ListBlastsParams`
**requestOptions:** `Blasts.RequestOptions`
## Messages Simulate
client.messages.simulate.user({ ...params }) -> Pinnacle.SimulateUserResponse
#### 📝 Description
Simulate inbound messages and button presses from a user.
#### 🔌 Usage
```typescript await client.messages.simulate.user({ from: "+14155551234", to: "+14155555678", message: { text: "Hello from the test user!" } }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.SimulateUserParams`
**requestOptions:** `Simulate.RequestOptions`
## PhoneNumbers Campaign
client.phoneNumbers.campaign.attach({ ...params }) -> Pinnacle.AttachedPhoneNumberResult
#### 📝 Description
Link a phone number to a specific campaign. Phone numbers must be linked to a campaign to send messages.
#### 🔌 Usage
```typescript await client.phoneNumbers.campaign.attach({ phones: ["+14155550123", "+14155559876", "+14155550111"], campaignType: "TOLL_FREE", campaignId: "tf_1234567890" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.phoneNumbers.AttachCampaignParams`
**requestOptions:** `Campaign.RequestOptions`
client.phoneNumbers.campaign.detach({ ...params }) -> Pinnacle.DetachedPhoneNumberResult
#### 📝 Description
Remove the association between a phone number and its attached campaign.
#### 🔌 Usage
```typescript await client.phoneNumbers.campaign.detach({ phones: ["+14155559876", "14155550111"] }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.phoneNumbers.DetachCampaignParams`
**requestOptions:** `Campaign.RequestOptions`
## Rcs Agents
client.rcs.agents.list({ ...params }) -> Pinnacle.ListAgentsResponse
#### 📝 Description
List all RCS agents with pagination. Results are sorted by creation date, newest first.
#### 🔌 Usage
```typescript await client.rcs.agents.list(); ```
#### ⚙️ Parameters
**request:** `Pinnacle.rcs.ListAgentsParams`
**requestOptions:** `Agents.RequestOptions`
## Rcs WhitelistedNumbers
client.rcs.whitelistedNumbers.list({ ...params }) -> Pinnacle.ListTestNumbersResponse
#### 📝 Description
List all whitelisted test numbers with optional filtering and pagination. Results are sorted by creation date, newest first.
#### 🔌 Usage
```typescript await client.rcs.whitelistedNumbers.list(); ```
#### ⚙️ Parameters
**request:** `Pinnacle.rcs.ListTestNumbersParams`
**requestOptions:** `WhitelistedNumbers.RequestOptions`
## Rcs Test
client.rcs.test.createAgent({ ...params }) -> Pinnacle.TestAgentResponse
#### 📝 Description
Create a new RCS test agent for development and testing. ## Overview Test agents let you build and test full RCS functionality — rich cards, carousels, buttons, quick replies, and media messages — without going through the full carrier review process. Messages from test agents can only be sent to [whitelisted phone numbers](/api-reference/rcs-agents/test/whitelist-number). ## Limits - **Maximum 5 test agents per account.** ## Image Requirements | Image | Format | Max Size | |-------|--------|----------| | Logo | JPEG, PNG | 50 KB | | Hero | JPEG, PNG | 200 KB | ## After Creation Once your test agent is created, you'll need to: 1. **Whitelist test phone numbers** using [`POST /rcs/test/agents/{agentId}/whitelist`](/api-reference/rcs-agents/test/whitelist-number). 2. **Accept the tester invite** on each whitelisted device. 3. **Send messages** using [`POST /messages/send/rcs`](/api-reference/messages/send-rcs) with the returned agent ID as the `from` field. > **2-Minute Cooldown** > > After creating a test agent, there is a mandatory 2-minute cooldown before you can whitelist phone numbers. > This is a requirement imposed by Google's RBM platform.
#### 🔌 Usage
```typescript await client.rcs.test.createAgent({ displayName: "Acme Support", description: "Get help with your Acme orders and account", logoUrl: "https://example.com/logo.png", heroUrl: "https://example.com/hero.png", phoneNumbers: [{ number: "+14155550123", label: "Support" }], emails: [{ address: "support@example.com", label: "Support" }], websites: [{ url: "https://example.com", label: "Website" }], privacyUrl: "https://example.com/privacy", termsUrl: "https://example.com/terms", color: "#FF6B00", isConversational: true, agentUseCase: "MULTI_USE" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.rcs.CreateTestAgentRequest`
**requestOptions:** `Test.RequestOptions`
client.rcs.test.updateAgent(agentId, { ...params }) -> Pinnacle.TestAgentResponse
#### 📝 Description
Update an existing RCS test agent's configuration. All fields are optional — only include the fields you want to update. ## Image Requirements If updating images, the same requirements apply as when creating an agent: | Image | Format | Max Size | |-------|--------|----------| | Logo | JPEG, PNG | 50 KB | | Hero | JPEG, PNG | 200 KB | > **2-Minute Cooldown** > > After updating a test agent, there is a mandatory 2-minute cooldown before you can whitelist phone numbers. > This is a requirement imposed by Google's RBM platform.
#### 🔌 Usage
```typescript await client.rcs.test.updateAgent("agent_abc123def456", { displayName: "Acme Premium Support" }); ```
#### ⚙️ Parameters
**agentId:** `string` — The RCS agent ID (must be prefixed with `agent_`).
**request:** `Pinnacle.rcs.UpdateTestAgentRequest`
**requestOptions:** `Test.RequestOptions`
client.rcs.test.whitelistNumber(agentId, { ...params }) -> Pinnacle.TestAgentWhitelistResponse
#### 📝 Description
Whitelist a phone number for testing with a specific test agent. During development and testing, RCS agents can only send messages to whitelisted phone numbers. Use this endpoint to whitelist specific phone numbers so you can send and receive messages from the test agent. ## Verification Process After whitelisting, the recipient must accept the tester invite: 1. The recipient's device will receive a message from "RBM Tester Management". 2. The recipient must tap "Make me a tester" to accept. 3. Once accepted, the status transitions from `PENDING` to `ACCEPTED`. ## Verification
Accepting the invite
Accepting the tester invite
Declining the invite
Declining the tester invite
## Cooldown There is a **2-minute cooldown** after creating or updating a test agent before you can whitelist numbers. Attempting to whitelist during the cooldown returns a `500` error with the remaining wait time.
#### 🔌 Usage
```typescript await client.rcs.test.whitelistNumber("agent_abc123def456", { phoneNumber: "+12345678901" }); ```
#### ⚙️ Parameters
**agentId:** `string` — The RCS agent ID (must be prefixed with `agent_`).
**request:** `Pinnacle.rcs.TestAgentWhitelistRequest`
**requestOptions:** `Test.RequestOptions`
client.rcs.test.getWhitelistStatus(agentId, { ...params }) -> Pinnacle.TestAgentWhitelistResponse
#### 📝 Description
Check the current whitelist status of a phone number for a specific test agent. Use this endpoint to poll the status of a previously whitelisted number and determine whether the recipient has accepted or rejected the tester invite. ## Status Values - **`PENDING`** — The tester invite was sent but the recipient has not yet responded. Ask the recipient to check their messages and accept the invite. - **`ACCEPTED`** — The recipient accepted the invite. Messages can be exchanged. - **`REJECTED`** — The recipient rejected the invite or the invite could not be delivered since the carrier does not support test agents. If the user rejected the invite, they can accept it again by tapping "Make me a tester" in the same message from "RBM Tester Management".
Accepting the invite
Accepting the tester invite
Declining the invite
Declining the tester invite
#### 🔌 Usage
```typescript await client.rcs.test.getWhitelistStatus("agent_abc123def456", { phoneNumber: "+12345678901" }); ```
#### ⚙️ Parameters
**agentId:** `string` — The RCS agent ID (must be prefixed with `agent_`).
**request:** `Pinnacle.rcs.TestGetWhitelistStatusRequest`
**requestOptions:** `Test.RequestOptions`
## Status Get
client.status.get.brand(brandId) -> Pinnacle.BrandStatus
#### 📝 Description
Retrieve a brand's status.
#### 🔌 Usage
```typescript await client.status.get.brand("b_1234567890"); ```
#### ⚙️ Parameters
**brandId:** `string` — The unique identifier of the brand you want to retrieve the status for. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
**requestOptions:** `Get.RequestOptions`
client.status.get.tollFree(campaignId) -> Pinnacle.TollFreeCampaignStatus
#### 📝 Description
Retrieve a toll-free campaign's status.
#### 🔌 Usage
```typescript await client.status.get.tollFree("tf_1234567890"); ```
#### ⚙️ Parameters
**campaignId:** `string` — The unique identifier of the toll-free campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `tf_`, for example: `tf_1234567890`.
**requestOptions:** `Get.RequestOptions`
client.status.get.dlc(campaignId) -> Pinnacle.DlcCampaignStatus
#### 📝 Description
Retrieve a 10DLC campaign's status.
#### 🔌 Usage
```typescript await client.status.get.dlc("dlc_1234567890"); ```
#### ⚙️ Parameters
**campaignId:** `string` — The unique identifier of the 10DLC campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
**requestOptions:** `Get.RequestOptions`
client.status.get.rcs(campaignId) -> Pinnacle.RcsCampaignStatus
#### 📝 Description
Retrieve a RCS campaign's status.
#### 🔌 Usage
```typescript await client.status.get.rcs("rcs_1234567890"); ```
#### ⚙️ Parameters
**campaignId:** `string` — The unique identifier of the RCS campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `rcs_`, for example: `rcs_1234567890`.
**requestOptions:** `Get.RequestOptions`
client.status.get.phoneNumber(phoneNumber) -> Pinnacle.PhoneNumberStatus
#### 📝 Description
Retrieve a phone number's order status and campaign attachment status.
Check if a number is active and ready to send messages.
#### 🔌 Usage
```typescript await client.status.get.phoneNumber("+14151234567"); ```
#### ⚙️ Parameters
**phoneNumber:** `string` — Phone number in E164 format that is in review.
**requestOptions:** `Get.RequestOptions`
## Tools Url
client.tools.url.create({ ...params }) -> Pinnacle.ShortenedUrl
#### 📝 Description
Create a shortened URL that redirects visitors to the provided destination URL.
#### 🔌 Usage
```typescript await client.tools.url.create({ url: "https://www.pinnacle.sh/", options: { expiresAt: "2025-06-23T16:18:25.000Z" } }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.tools.CreateUrlParams`
**requestOptions:** `Url.RequestOptions`
client.tools.url.get(linkId) -> Pinnacle.ShortenedUrlWithClickData
#### 📝 Description
Retrieve configuration and details for your shortened URL using its unique identifier.
#### 🔌 Usage
```typescript await client.tools.url.get("ePzVxILF"); ```
#### ⚙️ Parameters
**linkId:** `string` Unique identifier from your shortened URL. For example, for `https://pncl.to/ePzVxILF`, the `linkId` is `ePzVxILF`.
See the response of [Create Shortened URL](./create-url) for more information.
**requestOptions:** `Url.RequestOptions`
client.tools.url.update(linkId, { ...params }) -> Pinnacle.ShortenedUrl
#### 📝 Description
Update the destination or expiration date of an existing shortened URL. Expiring links cannot be updated into a permalink.
#### 🔌 Usage
```typescript await client.tools.url.update("ePzVxILF", { url: "https://www.pinnacle.sh/" }); ```
#### ⚙️ Parameters
**linkId:** `string` Unique identifier from your shortened URL. For example, for `https://pncl.to/ePzVxILF`, the `linkId` is `ePzVxILF`.
See the response of [Create Shortened URL](./create-url) for more information.
**request:** `Pinnacle.tools.UpdateUrlParams`
**requestOptions:** `Url.RequestOptions`
client.tools.url.list({ ...params }) -> Pinnacle.ListLinksResponse
#### 📝 Description
List all shortened URLs with pagination. Results are sorted by creation date, newest first.
#### 🔌 Usage
```typescript await client.tools.url.list(); ```
#### ⚙️ Parameters
**request:** `Pinnacle.tools.ListLinksParams`
**requestOptions:** `Url.RequestOptions`
## Tools File
client.tools.file.upload({ ...params }) -> Pinnacle.UploadResults
#### 📝 Description
Generate presigned URLs that let you upload files directly to our storage and allow your users to download them securely.
#### 🔌 Usage
```typescript await client.tools.file.upload({ contentType: "image/jpeg", size: 1024, name: "test.jpg", options: { deleteAt: "2025-12-31T23:59:59Z", download: { expiresAt: "2025-06-30T12:00:00.000Z" } } }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.tools.UploadFileParams`
**requestOptions:** `File_.RequestOptions`
client.tools.file.refresh({ ...params }) -> Pinnacle.RefreshedFile[]
#### 📝 Description
Refresh expiring presigned URLs for Pinnacle-hosted files to extend their access time. This only works for presigned download URLs. At this moment, you cannot refresh a presigned upload URL, generate a new one instead.
#### 🔌 Usage
```typescript await client.tools.file.refresh({ urls: ["https://server.trypinnacle.app/storage/v1/object/sign/vault/3/test.jpg?token=oldtoken", "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/document.pdf?token=oldtoken2", "invalid/url", "https://google.com"] }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.tools.RefreshFileParams`
**requestOptions:** `File_.RequestOptions`
## Tools ContactCard
client.tools.contactCard.get({ ...params }) -> Pinnacle.VCardData
#### 📝 Description
Retrieve contact information as a vCard and get a presigned URL to download the file. Contact cards can be sent [via MMS](/api-reference/messages/send-mms) as a media file.
#### 🔌 Usage
```typescript await client.tools.contactCard.get({ id: "cc_1234567890" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.tools.GetVcardParams`
**requestOptions:** `ContactCard.RequestOptions`
client.tools.contactCard.upsert({ ...params }) -> Pinnacle.VcardResource
#### 📝 Description
Create a new contact card or updates an existing one with full vCard data. Contact cards can be sent [via MMS](/api-reference/messages/send-mms) as a media file.
#### 🔌 Usage
```typescript await client.tools.contactCard.upsert({ id: "cc_1234567890", formattedName: "Jane Smith", name: { familyName: "Smith", givenName: "Jane", additionalNames: ["A."], honorificPrefixes: ["Dr."], honorificSuffixes: ["PhD"] }, nickname: ["Janie"], birthday: "1990-02-15", addresses: [{ countryName: "USA", extendedAddress: "Apt. 4B", locality: "Anytown", postalCode: "90210", postOfficeBox: "PO Box 123", region: "CA", streetAddress: "123 Main St", type: ["HOME", "PREF"] }], url: "https://app.pinnacle.sh", phones: [{ type: ["CELL"], value: "+15551234567" }], emails: [{ type: ["INTERNET"], value: "jane.smith@example.com" }], timezone: "America/Los_Angeles", geo: { latitude: 34.0522, longitude: -118.2437 }, title: "Engineer", role: "Developer", organization: { name: "Acme Co", units: ["Engineering", "R&D"] }, categories: ["Friend", "Colleague"], note: "Test contact entry", photo: "https://fastly.picsum.photos/id/853/200/200.jpg?hmac=f4LF-tVBBnJb9PQAVEO8GCTGWgLUnxQLw44rUofE6mQ" }); ```
#### ⚙️ Parameters
**request:** `Pinnacle.tools.UpsertVcardParams`
**requestOptions:** `ContactCard.RequestOptions`