Skip to main content

Bulk Creation

POST 

/bulkCreation

Submit sets of data about brands, campaigns, and phone numbers to create and assign. Please note that sub-usecases, phone numbers, and sample messages are each limited to 5 per campaign.

Request

Body

required

    brands

    object[]

    required

  • Array [

  • city City

    Possible values: <= 100 characters

    City name

    companyName Companyname

    Possible values: <= 100 characters

    (Required for Non-profit/private/public) Legal company name.

    country Countryrequired

    Possible values: <= 2 characters

    ISO2 2 characters country code. Example: US - United States

    description Descriptionrequired

    A brief description about the campaign.

    displayName Displaynamerequired

    Possible values: <= 100 characters

    Display name, marketing name, or DBA name of the brand.

    email Emailrequired

    Possible values: <= 100 characters

    Valid email address of brand support contact.

    entityType object

    Entity type behind the brand. This is the form of business establishment.

    firstName Firstname

    Possible values: <= 100 characters

    First name of business contact.

    lastName Lastname

    Possible values: <= 100 characters

    Last name of business contact.

    phone Phone

    Possible values: <= 20 characters

    Valid phone number in e.164 international format.

    phoneNumbers string[]required

    The phone numbers that will be assigned to the Sole Proprietor's campaign (Max of 5).

    postalCode Postalcode

    Possible values: <= 10 characters

    Postal codes. Use 5 digit zipcode for United States

    referenceId Referenceidrequired

    A user generated unique identifier that keeps track of sole proprietor brand/campaign combinations submitted during bulk creation.

    sampleMessages string[]required

    The sample_messages that will be assigned to the Sole Proprietor's campaign (Max of 5).

    state State

    Possible values: <= 20 characters

    State. Must be 2 letters code for United States.

    street Street

    Possible values: <= 100 characters

    Street number and name.

    subUsecases Usecase[]required

    Possible values: [2FA, ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES, CARRIER_EXEMPT, CHARITY, CONVERSATIONAL, CUSTOMER_CARE, DELIVERY_NOTIFICATION, EMERGENCY, FRAUD_ALERT, HIGHER_EDUCATION, LOW_VOLUME, MARKETING, MANUFACTURING, MIXED, POLITICAL, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, SECURITY_ALERT, SOCIAL, SWEEPSTAKE, SOLE_PROPRIETOR, TRIAL]

    The sub use cases that will be assigned to the Sole Proprietor's campaign (Max of 5).

    vertical object

    Vertical or industry segment of the brand or campaign.

    website Website

    Possible values: <= 100 characters

    Brand website URL.

  • ]

Responses

202: Successful Response

Schema

    brandCount Brandcountrequired

    The total number of brands to be created.

    taskId Taskidrequired

    The ID of the task associated with bulk Sole Proprietor brand and campaign creation.

422: Validation Error

Schema

    detail

    object[]

  • Array [

  • loc

    object[]

    required

  • Array [

  • anyOf

    string

  • ]

  • msg Messagerequired
    type Error Typerequired
  • ]

Loading...