Submit SMS brand registration for a company

URL Expired

The URL for this request expired after 30 days.

SMS Brand Registration Request Body

• companyUuid: string (required) - UUID of the company to register.

• vertical: string (enum) (required) - Industry vertical for SMS brand registration.

  • Options:
    • 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

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

• einLabel: string (required) - Legal business name registered with the IRS. Used as the EIN label.

• address: object (required) - Company address.

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

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

• termsOfServiceUrl: uri | null - 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.

• contactEmail: string (required) - Email of the authorized representative submitting this registration.

• contactLastName: string (required) - Last name of the authorized representative for SMS registration.

• contactFirstName: string (required) - First name of the authorized representative for SMS registration.

• contactPhone: string (required) - Phone number of the authorized representative submitting this registration.

• contactUsUrl: uri | null - A URL for support resources.

• customerSupportEmail: string | null - Customer-facing support email.

• customerSupportPhone: string | null - Customer-facing support phone.

Response Codes

• 200: SMS registration submitted successfully.

• 400: default error response.

• 404: default error response.

• 500: default error response.

Sample Curl Command

curl --request POST \
     --url https://services.fountain.com/api/serviceorganizations/processes/companies/companyUuid/smsRegistration \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '\n{\n  "vertical": "AGRICULTURE"\n}\n'  

Status Updates

Updated 3 months ago