Surge API

https://docs.surge.app/api-reference/
Admin
Surge API is a RESTful platform API that enables developers to integrate their applications with...
Tokens:37,199
Snippets:76
Trust Score:6.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example Request using cURL

Source: https://docs.surge.app/api-reference/endpoint/campaigns/create-campaign

Demonstrates how to make a POST request to create a campaign using cURL, including necessary headers and a sample JSON payload.

```bash
curl -X POST https://api.surge.app/accounts/acct_01j9a43avnfqzbjfch6pygv1td/campaigns \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
  "consent_flow": "When customers bring in their car for service, they will fill out this web form for intake: https://fastauto.shop/bp108c In it they can choose to opt in to text message notifications. If they choose to opt in, we will send them notifications to let them know if our mechanics find issues and once the car is ready to go, as well as links to invoices and to leave us feedback.",
  "description": "This phone number will send auto maintenance notifications to end users that have opted in. It will also be used for responding to customer inquiries and sending some marketing offers.",
  "message_samples": [
    "You are now opted in to receive repair notifications from DT Precision Auto. Frequency varies. Msg&data rates apply. Reply STOP to opt out.",
    "You\'re lucky that hundred shot of NOS didn\'t blow the welds on the intake!",
    "Your car is ready to go. See your invoice here: https://l.fastauto.shop/s034ij"
  ],
  "privacy_policy_url": "https://fastauto.shop/sms-privacy",
  "use_cases": [
    "account_notification",
    "customer_care",
    "marketing"
  ],
  "volume": "high",
  "includes": [
    "links",
    "phone_numbers"
  ],
  "link_sample": "https://l.fastauto.shop/s034ij",
  "terms_and_conditions_url": "https://fastauto.shop/terms-and-conditions"
}'
```

--------------------------------

### cURL Example: Create User - Surge App

Source: https://docs.surge.app/api-reference/endpoint/users/create

A command-line example demonstrating how to create a user using cURL. It shows the necessary HTTP method, endpoint, headers (including Authorization), and the JSON payload for the request body, including sample data for user details.

```curl
curl -X POST https://api.surge.app/accounts/acct_01j9a43avnfqzbjfch6pygv1td/users \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{ \
  "first_name": "Brian", \
  "last_name": "O\'Conner", \
  "metadata": { \
    "email": "boconner@toretti.family", \
    "user_id": 1234 \
  }, \
  "photo_url": "https://toretti.family/people/brian.jpg" \
}'
```

--------------------------------

### cURL Example for Checking Verification

Source: https://docs.surge.app/api-reference/endpoint/verifications/check

A practical example demonstrating how to use cURL to send a POST request to the Surge App API to check a verification code. It includes necessary headers and the request payload.

```curl
curl -X POST https://api.surge.app/verifications/vfn_01jayh15c2f2xamftg0xpyq1nj/checks \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
  "code": "123456"
}'
```

--------------------------------

### Surge API: Send Message cURL Example

Source: https://docs.surge.app/api-reference/endpoint/messages/send

Example cURL command to send a message via the Surge API, including authorization, content type, and a sample JSON payload.

```bash
curl -X POST https://api.surge.app/accounts/acct_01j9a43avnfqzbjfch6pygv1td/messages \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{ \
  "attachments": [ \
    { \
      "url": "https://toretto.family/coronas.gif" \
    } \
  ], \
  "body": "Thought you could leave without saying goodbye?", \
  "conversation": { \
    "contact": { \
      "first_name": "Dominic", \
      "last_name": "Toretto", \
      "phone_number": "+18015551234" \
    } \
  } \
}'
```

--------------------------------

### Surge API: Send Message Response Example

Source: https://docs.surge.app/api-reference/endpoint/messages/send

Example JSON response received after successfully sending a message through the Surge API, detailing the message and its associated conversation.

```json
{
  "attachments": [
    {
      "id": "att_01j9e0m1m6fc38gsv2vkfqgzz2",
      "type": "image",
      "url": "https://api.surge.app/attachments/att_01jbwyqj7rejzat7pq03r7fgmf"
    }
  ],
  "body": "Thought you could leave without saying goodbye?",
  "conversation": {
    "contact": {
      "id": "ctc_01j9dy8mdzfn3r0e8x1tbdrdrf",
      "phone_number": "+18015551234",
      "first_name": "Dominic",
      "last_name": "Toretto"
    },
    "id": "cnv_01j9e0dgmdfkj86c877ws0znae",
    "phone_number": {
      "id": "pn_01jsjwe4d9fx3tpymgtg958d9w",
      "number": "+18015552345",
      "type": "local"
    }
  },
  "id": "msg_01j9e0m1m6fc38gsv2vkfqgzz2"
}
```

--------------------------------

### Create User API Endpoint - Surge App

Source: https://docs.surge.app/api-reference/endpoint/users/create

Details for creating a new user within a specific account. Includes the HTTP method, endpoint URL, required path parameters, headers, request body schema, and example responses. This endpoint is used to add new user profiles to the Surge platform.

```APIDOC
POST /accounts/:account_id/users

Creates a new User object.

### Path parameters
account_id: string (Required) - The account for which the user should be created.

### Headers
Authorization: string (Required) - Bearer authentication of the form Bearer <token>, where token is your auth token.

### Request
User params:
  first_name: string (Required) - The user's first name.
  last_name: string (Optional) - The user's last name.
  metadata: object (Optional) - Set of key-value pairs that will be stored with the user.
  photo_url: string (Optional, format: "url") - URL of a photo to be used as the user's avatar.

### Response
User:
  first_name: string or null
  id: string or null - Unique identifier for the object.
  last_name: string or null
  metadata: object or null
  photo_url: string or null (format: "url")
```

--------------------------------

### Surge Client Initialization and Contact Retrieval (Python)

Source: https://docs.surge.app/api-reference/endpoint/contacts/get-contact

Demonstrates how to initialize the Surge client with account credentials and a token, and then use it to retrieve a specific contact by its ID.

```Python
from surge import Surge

client = Surge(
  surge_account="YOUR_SURGE_ACCOUNT",
  token="YOUR_TOKEN",
)

contact_details = client.contacts.show(
  id="ctc_01j9dy8mdzfn3r0e8x1tbdrdrf",
)
```

--------------------------------

### Campaigns API

Source: https://docs.surge.app/api-reference/endpoint/campaigns/create-campaign

Endpoint for creating campaigns.

```APIDOC
POST /campaigns/create-campaign
  Description: Create a campaign.
  Parameters: (Details not provided in source)
  Returns: (Details not provided in source)
```

--------------------------------

### Message Sent Event Payload

Source: https://docs.surge.app/api-reference/webhooks/events/message-sent

Example JSON payload structure for the 'message.sent' webhook event, detailing message content, sender, recipient, and associated conversation information.

```json
{
  "account_id": "acct_01japd271aeatb7txrzr2xj8sg",
  "data": {
    "id": "msg_01jjnn7s0zfx5tdcsxjfy93et2",
    "body": "Dude, I almost had you!",
    "attachments": [
      {
        "id": "att_01jjnn75vgepj8bnnttfw1st5s",
        "type": "image",
        "url": "https://toretto.family/skyline.jpg"
      }
    ],
    "sent_at": "2024-10-21T23:29:41Z",
    "conversation": {
      "id": "cnv_01jav8xy7fe4nsay3c9deqxge9",
      "phone_number": {
        "id": "pn_01jsjwe4d9fx3tpymgtg958d9w",
        "number": "+18015556789",
        "type": "local"
      },
      "contact": {
        "email": "dom@toretto.family",
        "id": "ctc_01ja88cboqffhswjx8zbak3ykk",
        "last_name": "Dominic",
        "first_name": "Toretto",
        "metadata": {
          "car": "1970 Dodge Charger R/T"
        },
        "phone_number": "+18015551234"
      }
    }
  },
  "type": "message.sent"
}
```

--------------------------------

### Create a Contact (Python SDK)

Source: https://docs.surge.app/api-reference/endpoint/contacts/create

Demonstrates how to use the Surge Python SDK to create a new contact within a specified account. Requires authentication with account credentials.

```Python
from surge import Surge

client = Surge(
 surge_account="YOUR_SURGE_ACCOUNT",
 token="YOUR_TOKEN",
)
client.contacts.create(
 first_name="Dominic",
 last_name="Toretto",
 phone_number="+18015551234",
)
```

--------------------------------

### Users API

Source: https://docs.surge.app/api-reference/endpoint/campaigns/create-campaign

Endpoints for managing users, including creation, retrieval, and updates.

```APIDOC
POST /users/create
  Description: Create a user.
  Parameters: (Details not provided in source)
  Returns: (Details not provided in source)

GET /users/get-user
  Description: Retrieve a user.
  Parameters: (Details not provided in source)
  Returns: (Details not provided in source)

PATCH /users/update-user
  Description: Update a user.
  Parameters: (Details not provided in source)
  Returns: (Details not provided in source)
```

--------------------------------

### Verifications API Endpoints

Source: https://docs.surge.app/api-reference/webhooks/introduction

Handle verification processes, including creation and checking.

```APIDOC
POST /api-reference/endpoint/verifications/create
  - Creates a new verification.

POST /api-reference/endpoint/verifications/check
  - Checks the status of a verification.
```

--------------------------------

### Webhooks API

Source: https://docs.surge.app/api-reference/endpoint/campaigns/create-campaign

Introduction to webhooks and signature validation.

```APIDOC
Introduction: Overview of webhook functionality.

Signature validation: Details on validating webhook signatures. (Specifics not provided in source)
```

--------------------------------

### Accounts API

Source: https://docs.surge.app/api-reference/endpoint/campaigns/create-campaign

Endpoints for managing accounts, including creation and updates.

```APIDOC
POST /accounts
  Description: Create an account.
  Parameters: (Details not provided in source)
  Returns: (Details not provided in source)

PATCH /accounts
  Description: Update an account.
  Parameters: (Details not provided in source)
  Returns: (Details not provided in source)
```

--------------------------------

### Verifications API

Source: https://docs.surge.app/api-reference/endpoint/campaigns/create-campaign

Endpoints for creating and checking verifications.

```APIDOC
POST /verifications/create
  Description: Create a verification.
  Parameters: (Details not provided in source)
  Returns: (Details not provided in source)

POST /verifications/check
  Description: Check a verification.
  Parameters: (Details not provided in source)
  Returns: (Details not provided in source)
```

--------------------------------

### Surge App API Endpoints

Source: https://docs.surge.app/api-reference/webhooks/events/message-sent

Comprehensive documentation for Surge App API endpoints, covering account management, contact operations, message sending, phone number provisioning, user management, token creation, verification processes, and webhook handling.

```APIDOC
Accounts:
  POST /accounts/create
    Creates a new account.
  PATCH /accounts/update
    Updates an existing account.

Contacts:
  POST /contacts/create
    Creates a new contact.
    Parameters:
      - email: string
      - first_name: string (optional)
      - last_name: string (optional)
      - phone_number: string (required for some operations)
      - metadata: object (optional)
  GET /contacts/get-contact
    Retrieves a specific contact.
    Parameters:
      - contact_id: string (required)
  PATCH /contacts/update
    Updates an existing contact.
    Parameters:
      - contact_id: string (required)
      - email: string (optional)
      - first_name: string (optional)
      - last_name: string (optional)
      - phone_number: string (optional)
      - metadata: object (optional)

Messages:
  POST /messages/send
    Sends a message to a contact.
    Parameters:
      - to: string (recipient phone number)
      - from: string (Surge phone number)
      - body: string (message content)
      - attachments: array of attachment objects (optional)

Phone Numbers:
  POST /phone-numbers/create
    Provisions a new phone number for your account.

Users:
  POST /users/create
    Creates a new user associated with an account.
  GET /users/get-user
    Retrieves details for a specific user.
    Parameters:
      - user_id: string (required)
  PATCH /users/update-user
    Updates an existing user's information.
    Parameters:
      - user_id: string (required)

Tokens:
  POST /tokens/create-token
    Creates a signed user token for authentication or specific actions.

Verifications:
  POST /verifications/create
    Initiates a verification process (e.g., SMS code).
    Parameters:
      - phone_number: string (required)
      - channel: string (e.g., 'sms', 'voice')
  POST /verifications/check
    Checks the status or validity of a verification.
    Parameters:
      - verification_id: string (required)
      - code: string (the verification code entered by the user)

Webhooks:
  Introduction: Provides an overview of webhook functionality.
  Signature validation: Details on how to validate incoming webhook signatures.
  Events:
    message.sent: Triggered when a message is successfully sent from your Surge number.
      Payload Structure:
        account_id: string (Required) - The ID of the account.
        type: string (Required) - Always 'message.sent'.
        data: object (message details)
          id: string - Unique message identifier.
          body: string - Content of the message.
          attachments: array of attachment objects (optional)
            id: string - Unique attachment identifier.
            type: enum ('file', 'image', 'link', 'video') - Type of attachment.
            url: string - URL for the attachment.
          sent_at: string - ISO 8601 timestamp of sending.
          conversation: object (conversation details)
            id: string - Unique conversation identifier.
            phone_number: object (Surge phone number details)
              id: string - Unique phone number identifier.
              number: string - E.164 formatted phone number.
              type: enum ('local', 'toll_free', 'short_code', 'demo') - Type of phone number.
            contact: object (contact details)
              email: string - Contact's email.
              id: string - Unique contact identifier.
              first_name: string (optional) - Contact's first name.
              last_name: string (optional) - Contact's last name.
              phone_number: string - Contact's phone number in E.164 format.
              metadata: object (optional) - Custom data associated with the contact.

  Related Events:
    message.received: Information on events triggered when a message is received.
```

--------------------------------

### Surge App API Endpoints Overview

Source: https://docs.surge.app/api-reference/endpoint/accounts/create

Lists available API endpoints for various functionalities within the Surge App, including accounts, blasts, campaigns, contacts, messages, phone numbers, users, tokens, verifications, and webhooks.

```APIDOC
API Endpoints:

*   Accounts:
    *   POST /accounts (Create an account)
    *   PATCH /accounts (Update an account)
*   Blasts:
    *   POST /blasts/send (Send a blast)
*   Campaigns:
    *   POST /campaigns/create-campaign (Create a campaign)
*   Contacts:
    *   POST /contacts/create (Create a contact)
    *   GET /contacts/get-contact (Retrieve a contact)
    *   PATCH /contacts/update (Update a contact)
*   Messages:
    *   POST /messages/send (Send a message)
*   Phone Numbers:
    *   POST /phone-numbers/create (Create a phone number)
*   Users:
    *   POST /users/create (Create a user)
    *   GET /users/get-user (Retrieve a user)
    *   PATCH /users/update-user (Update a user)
*   Tokens:
    *   POST /tokens/create-token (Create a signed user token)
*   Verifications:
    *   POST /verifications/create (Create a verification)
    *   POST /verifications/check (Check a verification)
*   Webhooks:
    *   Introduction
    *   Signature validation
```

--------------------------------

### Tokens API

Source: https://docs.surge.app/api-reference/endpoint/campaigns/create-campaign

Endpoint for creating signed user tokens.

```APIDOC
POST /tokens/create-token
  Description: Create a signed user token.
  Parameters: (Details not provided in source)
  Returns: (Details not provided in source)
```

--------------------------------

### User Management Endpoints

Source: https://docs.surge.app/api-reference/home/introduction

Endpoints for managing user accounts, including creation, retrieval, and updates.

```APIDOC
POST /users/create
  - Creates a new user.
  - Parameters:
    - (Request Body): User creation details.
  - Returns:
    - Details of the newly created user.

GET /users/get-user
  - Retrieves a specific user.
  - Parameters:
    - userId: Identifier for the user.
  - Returns:
    - Details of the requested user.

PATCH /users/update-user
  - Updates an existing user.
  - Parameters:
    - (Request Body): User update details.
  - Returns:
    - Details of the updated user.
```

--------------------------------

### Create Account API

Source: https://docs.surge.app/api-reference/endpoint/accounts/create

Endpoint for creating a new account within the Surge platform. It requires account details like name and time zone, and optionally accepts organization information. The response includes the newly created account's ID.

```APIDOC
POST /accounts

Creates a new Account within the calling Platform.

### Headers
Authorization: Bearer <token> (Required)
  Bearer authentication of the form Bearer <token>, where token is your auth token.

### Request
Account params:
  name: string (Required)
    The name of the account that will be visible for your internal organizational purposes. This will also be the default public-facing brand name unless you also set a `brand_name`, but otherwise the account name will never be displayed anywhere outside of Surge HQ, and may include your ID for the account or anything else that may help you.
  time_zone: string (Required)
    This is the time zone in which the account is headquartered. This time zone may be used for compliance with TCPA restrictions on when messages may be sent.
  brand_name: string or null (Optional)
    The name by which the people this account communicates with know it. If not provided, this will match the name field.
  organization: object (Optional)
    The legal entity on whose behalf the account will be operated.
    Properties:
      address: object (Optional)
        Properties:
          country: string
          line1: string
          line2: string or null
          locality: string
          name: string
          postal_code: string
          region: string
      contact: object (Optional)
        Properties:
          email: string
          first_name: string
          last_name: string
          phone_number: string
          title: string
          title_other: string
      country: string
      email: string
      identifier: string
      identifier_type: string
      industry: string
      mobile_number: string
      regions_of_operation: array of strings
      registered_name: string
      stock_exchange: string or null
      stock_symbol: string or null
      type: string
      website: string

### Response
201 Created
Account:
  id: string
    The account ID
  name: string
    The name of the account
  time_zone: string or null
    The time zone for the account
```

```curl
curl -X POST https://api.surge.app/accounts \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{ \
  "name": "Account #2840 - DT Precision Auto", \
  "time_zone": "America/Los_Angeles", \
  "brand_name": "DT Precision Auto", \
  "organization": { \
    "address": { \
      "country": "US", \
      "line1": "2640 Huron St", \
      "line2": null, \
      "locality": "Los Angeles", \
      "name": "DT Precision Auto", \
      "postal_code": "90065", \
      "region": "CA" \
    }, \
    "contact": { \
      "email": "dom@dtprecisionauto.com", \
      "first_name": "Dominic", \
      "last_name": "Toretto", \
      "phone_number": "+13235556439", \
      "title": "other", \
      "title_other": "Owner" \
    }, \
    "country": "US", \
    "email": "dom@dtprecisionauto.com", \
    "identifier": "123456789", \
    "identifier_type": "ein", \
    "industry": "automotive", \
    "mobile_number": "+13235556439", \
    "regions_of_operation": [ \
      "usa_and_canada" \
    ], \
    "registered_name": "DT Precision Auto LLC", \
    "stock_exchange": null, \
    "stock_symbol": null, \
    "type": "llc", \
    "website": "https://dtprecisionauto.com" \
  } \
}'
```

```json
{
  "id": "acct_01jpqjvfg9enpt7pyxd60pcmxj",
  "name": "D·T Precision Auto Shop",
  "time_zone": "America/Los_Angeles"
}
```

--------------------------------

### APIDOC: Surge App Campaign Parameters

Source: https://docs.surge.app/api-reference/endpoint/campaigns/create-campaign

This section details the parameters required for creating or updating a campaign within the Surge App API. It covers consent flow, campaign purpose, message samples, privacy policy, use cases, volume, and optional inclusions like links or age-gated content.

```APIDOC
Campaign Parameters:

Request:
  consent_flow: string
    Required: Yes
    Constraints: >=40 characters, <=4096 characters
    Description: A string explaining the method through which end users will opt in to receive messages from the brand. Typically this should include URLs for opt-in forms or screenshots that might be helpful in explaining the flow to someone unfamiliar with the organization’s purpose.

  description: string
    Required: Yes
    Constraints: >=40 characters, <=4096 characters
    Description: An explanation of the organization's purpose and how it will be using text messaging to accomplish that purpose.

  message_samples: list of strings
    Required: Yes
    Description: An array of 2-5 strings with examples of the messages that will be sent from this campaign. Typically the first sample should be a compliance message like `You are now opted in to messages from {brand name}. Frequency varies. Msg&data rates apply. Reply STOP to opt out.` These samples don’t necessarily need to be the only templates that will be used for the campaign, but they should reflect the purpose of the messages that will be sent. Any variable content can be reflected by wrapping it in square brackets like `[customer name]`.

  privacy_policy_url: string
    Required: Yes
    Constraints: format: "url", <=255 characters
    Description: The URL of the privacy policy for the brand in question. This may be a shared privacy policy if it's the policy that is displayed to end users when they opt in to messaging.

  use_cases: list of enums
    Required: Yes
    Description: A list containing 1-5 types of messages that will be sent with this campaign.
    Available use cases:
    - `account_notification`: For sending reminders, alerts, and general account-related notifications like booking confirmations or appointment reminders.
    - `customer_care`: For account support, troubleshooting, and general customer service communication.
    - `delivery_notification`: For notifying customers about the status of product or service deliveries.
    - `fraud_alert`: For warning customers about suspicious or potentially fraudulent activity.
    - `higher_education`: For messaging related to colleges, universities, and school districts outside of K–12.
    - `marketing`: For promotional or advertising messages intended to market products or services.
    - `polling_voting`: For conducting surveys, polls, or voting-related messaging.
    - `public_service_announcement`: For raising awareness about social issues or important public information.
    - `security_alert`: For alerts related to potential security breaches or compromised systems requiring user action.
    - `two_factor_authentication`: For sending one-time passwords or verification codes for login or password reset.
    For access to special use cases not shown here, reach out to support@surge.app.

  volume: enum
    Required: Yes
    Description: This will be one of the following:
    - `low`: The campaign will be allowed to send up to 2000 SMS segments to T-Mobile customers each day. In this case your platform will be charged for the setup fee for a low volume number upon receipt of the API request.
    - `high`: The campaign will be allowed to send up to 200k SMS segments to T-Mobile customers each day, depending on the trust score assigned by The Campaign Registry. Your platform will be charged for the setup fee for a high volume number upon receipt of the API request, and phone numbers will be charged as high volume numbers going forward.
    Allowed values: `high`, `low`

  includes: list of enums (Optional)
    Description: A list of properties that this campaign should include. These properties can be any of the following values:
    - `links`: whether the campaign might send links in messages
    - `phone_numbers`: whether the campaign might send phone numbers in messages
    - `age_gated`: whether the campaign contains age gated content (controlled substances or adult content)
    - `direct_lending`: whether the campaign contains content related to direct lending or other loan arrangements
    Allowed values: `links`, `phone_numbers`, `age_gated`, `direct_lending`

  link_sample: string (Optional)
    Constraints: format: "url", <=255 characters
    Description: A sample link that might be sent by this campaign. If links from other domains are sent through this campaign, they are much more likely to be filtered by the carriers. If link shortening is enabled for the account, the link shortener URL will be used instead of what is provided. Reach out to support if you would like to disable automatic link shortening.

  terms_and_conditions_url: string (Optional)
    Constraints: format: "url", <=255 characters
    Description: The URL of the terms and conditions presented to end users when they opt in to messaging. These terms and conditions may be shared among all of a platform's customers if they're the terms that are presented to end users when they opt in to messaging.
```

--------------------------------

### Blasts API

Source: https://docs.surge.app/api-reference/endpoint/campaigns/create-campaign

Endpoint for sending blasts.

```APIDOC
POST /blasts/send
  Description: Send a blast.
  Parameters: (Details not provided in source)
  Returns: (Details not provided in source)
```

--------------------------------

### Campaigns API Endpoint

Source: https://docs.surge.app/api-reference/webhooks/introduction

Create and manage SMS campaigns via the API.

```APIDOC
POST /api-reference/endpoint/campaigns/create-campaign
  - Creates a new campaign.
```

--------------------------------

### Accounts API Endpoints

Source: https://docs.surge.app/api-reference/webhooks/introduction

Manage your accounts via the API. Supports creating new accounts and updating existing ones.

```APIDOC
POST /api-reference/endpoint/accounts/create
  - Creates a new account.

PATCH /api-reference/endpoint/accounts/update
  - Updates an existing account.
```

--------------------------------

### Contacts API

Source: https://docs.surge.app/api-reference/endpoint/campaigns/create-campaign

Endpoints for managing contacts, including creation, retrieval, and updates.

```APIDOC
POST /contacts/create
  Description: Create a contact.
  Parameters: (Details not provided in source)
  Returns: (Details not provided in source)

GET /contacts/get-contact
  Description: Retrieve a contact.
  Parameters: (Details not provided in source)
  Returns: (Details not provided in source)

PATCH /contacts/update
  Description: Update a contact.
  Parameters: (Details not provided in source)
  Returns: (Details not provided in source)
```

--------------------------------

### Messages API

Source: https://docs.surge.app/api-reference/endpoint/campaigns/create-campaign

Endpoint for sending messages.

```APIDOC
POST /messages/send
  Description: Send a message.
  Parameters: (Details not provided in source)
  Returns: (Details not provided in source)
```

--------------------------------

### Verification Endpoints

Source: https://docs.surge.app/api-reference/home/introduction

Endpoints for managing verification processes, including initiating and checking verification statuses.

```APIDOC
POST /verifications/create
  - Initiates a new verification process.
  - Parameters:
    - (Request Body): Verification details (e.g., phone number, type).
  - Returns:
    - Status of the verification initiation.

POST /verifications/check
  - Checks the status or result of a verification.
  - Parameters:
    - (Request Body): Verification identifier and submitted code.
  - Returns:
    - Verification result (e.g., success/failure).
```

--------------------------------

### Users API Endpoints

Source: https://docs.surge.app/api-reference/webhooks/introduction

Manage users within your Surge account, including creation, retrieval, and updates.

```APIDOC
POST /api-reference/endpoint/users/create
  - Creates a new user.

GET /api-reference/endpoint/users/get-user
  - Retrieves a specific user.

PATCH /api-reference/endpoint/users/update-user
  - Updates an existing user.
```

--------------------------------

### Surge API Endpoints Overview

Source: https://docs.surge.app/api-reference/webhooks/events/conversation-created

Provides a list of available API endpoints for managing various resources within the Surge platform. This includes operations for accounts, contacts, messages, phone numbers, users, tokens, and verifications.

```APIDOC
Accounts:
  POST /accounts/create
  PATCH /accounts/update

Blasts:
  POST /blasts/send

Campaigns:
  POST /campaigns/create-campaign

Contacts:
  POST /contacts/create
  GET /contacts/get-contact
  PATCH /contacts/update

Messages:
  POST /messages/send

Phone Numbers:
  POST /phone-numbers/create

Users:
  POST /users/create
  GET /users/get-user
  PATCH /users/update-user

Tokens:
  POST /tokens/create-token

Verifications:
  POST /verifications/create
  POST /verifications/check

Webhooks:
  Introduction
  Signature validation
  Events:
    call_ended
    message_delivered
    conversation_created
```

--------------------------------

### Contacts API Endpoints

Source: https://docs.surge.app/api-reference/webhooks/introduction

Manage your contacts, including creation, retrieval, and updates.

```APIDOC
POST /api-reference/endpoint/contacts/create
  - Creates a new contact.

GET /api-reference/endpoint/contacts/get-contact
  - Retrieves a specific contact.

PATCH /api-reference/endpoint/contacts/update
  - Updates an existing contact.
```

--------------------------------

### Campaign Creation Endpoint

Source: https://docs.surge.app/api-reference/home/introduction

Endpoint for creating new marketing or operational campaigns within the Surge platform.

```APIDOC
POST /campaigns/create-campaign
  - Creates a new campaign.
  - Parameters:
    - (Request Body): Campaign configuration details.
  - Returns:
    - Details of the newly created campaign.
```
Tokens:
Raw