Sign in

v1

latestOpenAPI 3.0.12026-07-245752052.0 MB
companies

Submit SMS brand registration for a company

post/api/serviceorganizations/processes/companies/{companyUuid}/smsRegistration

Path parameters

companyUuidstring required

UUID of the company to register

Request body

vertical'AGRICULTURE' | 'COMMUNICATION' | 'CONSTRUCTION' | 'EDUCATION' | 'ENERGY' | 'ENTERTAINMENT' | 'FINANCIAL' | 'GAMBLING' | 'GOVERNMENT' | 'HEALTHCARE' | 'HOSPITALITY' | 'HUMAN_RESOURCES' | 'INSURANCE' | 'LEGAL' | 'MANUFACTURING' | 'NGO' | 'POLITICAL' | 'POSTAL' | 'PROFESSIONAL' | 'REAL_ESTATE' | 'RETAIL' | 'TECHNOLOGY' | 'TRANSPORTATION' required

Industry vertical for SMS brand registration.

einstring required

Employer Identification Number (format XX-XXXXXXX). Ignored when a default EIN already exists for the company.

einLabelstring required

Legal business name registered with the IRS. Used as the EIN label.

mainWebsiteUrlstring uri nullable

Company website URL with protocol. Send null/omit to use the Fountain-hosted page; Hire fills in the canonical URL when blank.

privacyPolicyUrlstring uri nullable

URL to the company privacy policy page. Send null/omit to use the Fountain-hosted page; Hire fills in the canonical URL when blank.

termsOfServiceUrlstring uri nullable

URL to the company terms of service page. Send null/omit to use the Fountain-hosted page; Hire fills in the canonical URL when blank.

contactEmailstring email required

Email of the authorized representative submitting this registration.

contactLastNamestring required

Last name of the authorized representative for SMS registration.

contactFirstNamestring required

First name of the authorized representative for SMS registration.

contactPhonestring required

Phone number of the authorized representative submitting this registration.

contactUsUrlstring uri nullable

A URL for support resources

customerSupportEmailstring email nullable

Customer-facing support email

customerSupportPhonestring nullable

Customer-facing support phone

Example request

{
  "vertical": "TRANSPORTATION",
  "ein": "12-3456789",
  "einLabel": "Acme Corp",
  "address": {
    "address1": "123 Main St",
    "address2": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94101",
    "country": "US"
  },
  "mainWebsiteUrl": "https://www.acme.com",
  "privacyPolicyUrl": "https://www.acme.com/privacy",
  "termsOfServiceUrl": "https://www.acme.com/terms",
  "contactEmail": "jane.smith@acme.com",
  "contactLastName": "Smith",
  "contactFirstName": "Jane",
  "contactPhone": "+14155552671",
  "contactUsUrl": "https://www.acme.com/contact",
  "customerSupportEmail": "support@acme.com",
  "customerSupportPhone": "+18005551234"
}

Response

SMS registration submitted successfully