curl --request POST \
--url https://api.quo.com/a2p-registration \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'Quo-Api-Version: <quo-api-version>' \
--data '
{
"name": "Acme Inc",
"businessType": "Limited Liability Corporation",
"companyType": "Private",
"industry": "Technology",
"employeeCount": 25,
"avgDailyCallVolume": 100,
"regionsOfOperation": [
"USA and Canada"
],
"websiteUrl": "https://acme.example",
"idType": "USA: Employer Identification Number (EIN)",
"idNumber": "12-3456789",
"address": {
"line1": "1 Main St",
"city": "San Francisco",
"region": "CA",
"postalCode": "94110",
"country": "US",
"line2": "Suite 200"
},
"personOfContact": {
"firstName": "Ada",
"lastName": "Lovelace",
"jobTitle": "CTO",
"jobPosition": "Director",
"email": "ada@acme.example",
"phoneNumber": "+15551234567"
},
"messageTypes": [
"customer_support",
"transactional_notifications"
],
"alternateName": "Acme",
"ticker": "ACME",
"exchange": "NASDAQ"
}
'{
"data": {
"id": "RG123abc",
"draft": true,
"status": "pending",
"statusMessages": [
{
"errorCode": 123,
"errorReason": "<string>",
"fieldName": "<string>",
"fields": [
"<string>"
]
}
],
"autofillStatus": "completed",
"type": "standard",
"assignedPnId": "<string>",
"firstSubmittedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"businessInfo": {
"name": "Acme Inc",
"alternateName": "<string>",
"businessType": "Limited Liability Corporation",
"companyType": "Private",
"industry": "<string>",
"employeeCount": 123,
"avgDailyCallVolume": 123,
"regionsOfOperation": [
"Africa"
],
"websiteUrl": "<string>",
"idType": "USA: Employer Identification Number (EIN)",
"idNumber": "<string>",
"ticker": "<string>",
"exchange": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"country": "US"
},
"personOfContact": {
"firstName": "<string>",
"lastName": "<string>",
"jobTitle": "<string>",
"jobPosition": "<string>",
"email": "jsmith@example.com",
"phoneNumber": "<string>"
}
},
"messaging": {
"useCase": "<string>",
"personalUse": true,
"consent": {
"digitalForm": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"mobileApp": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"onSite": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"other": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"physicalForm": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"textMessage": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"verbal": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"websiteForm": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"written": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
}
}
}
}
}{
"message": "The input was invalid",
"docs": "https://quo.com/docs",
"title": "Bad Request",
"trace": "6897907457496870895"
}{
"message": "Unauthorized",
"docs": "https://quo.com/docs",
"title": "Unauthorized",
"trace": "6897907457496870895"
}{
"message": "This subscription is not able to register for A2P",
"docs": "https://quo.com/docs",
"title": "Subscription Expired",
"trace": "6897907457496870895"
}{
"message": "You must be an organization admin or owner to create an A2P registration",
"docs": "https://quo.com/docs",
"title": "Forbidden",
"trace": "6897907457496870895"
}{
"message": "Not Found",
"docs": "https://quo.com/docs",
"title": "Not Found",
"trace": "6897907457496870895"
}{
"message": "This organization already has an A2P registration",
"docs": "https://quo.com/docs",
"title": "Conflict",
"trace": "6897907457496870895"
}{
"message": "idNumber must contain exactly nine digits for idType USA: Employer Identification Number (EIN)",
"docs": "https://quo.com/docs",
"title": "Unprocessable Entity",
"trace": "6897907457496870895"
}{
"message": "We have encountered an unknown error",
"docs": "https://quo.com/docs",
"title": "Unexpected",
"trace": "6897907457496870895"
}Create the A2P registration
Create the organization’s A2P (10DLC) draft registration. Organizations have at most one registration, so this returns 409 if one already exists.
curl --request POST \
--url https://api.quo.com/a2p-registration \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'Quo-Api-Version: <quo-api-version>' \
--data '
{
"name": "Acme Inc",
"businessType": "Limited Liability Corporation",
"companyType": "Private",
"industry": "Technology",
"employeeCount": 25,
"avgDailyCallVolume": 100,
"regionsOfOperation": [
"USA and Canada"
],
"websiteUrl": "https://acme.example",
"idType": "USA: Employer Identification Number (EIN)",
"idNumber": "12-3456789",
"address": {
"line1": "1 Main St",
"city": "San Francisco",
"region": "CA",
"postalCode": "94110",
"country": "US",
"line2": "Suite 200"
},
"personOfContact": {
"firstName": "Ada",
"lastName": "Lovelace",
"jobTitle": "CTO",
"jobPosition": "Director",
"email": "ada@acme.example",
"phoneNumber": "+15551234567"
},
"messageTypes": [
"customer_support",
"transactional_notifications"
],
"alternateName": "Acme",
"ticker": "ACME",
"exchange": "NASDAQ"
}
'{
"data": {
"id": "RG123abc",
"draft": true,
"status": "pending",
"statusMessages": [
{
"errorCode": 123,
"errorReason": "<string>",
"fieldName": "<string>",
"fields": [
"<string>"
]
}
],
"autofillStatus": "completed",
"type": "standard",
"assignedPnId": "<string>",
"firstSubmittedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"businessInfo": {
"name": "Acme Inc",
"alternateName": "<string>",
"businessType": "Limited Liability Corporation",
"companyType": "Private",
"industry": "<string>",
"employeeCount": 123,
"avgDailyCallVolume": 123,
"regionsOfOperation": [
"Africa"
],
"websiteUrl": "<string>",
"idType": "USA: Employer Identification Number (EIN)",
"idNumber": "<string>",
"ticker": "<string>",
"exchange": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"country": "US"
},
"personOfContact": {
"firstName": "<string>",
"lastName": "<string>",
"jobTitle": "<string>",
"jobPosition": "<string>",
"email": "jsmith@example.com",
"phoneNumber": "<string>"
}
},
"messaging": {
"useCase": "<string>",
"personalUse": true,
"consent": {
"digitalForm": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"mobileApp": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"onSite": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"other": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"physicalForm": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"textMessage": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"verbal": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"websiteForm": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"written": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
}
}
}
}
}{
"message": "The input was invalid",
"docs": "https://quo.com/docs",
"title": "Bad Request",
"trace": "6897907457496870895"
}{
"message": "Unauthorized",
"docs": "https://quo.com/docs",
"title": "Unauthorized",
"trace": "6897907457496870895"
}{
"message": "This subscription is not able to register for A2P",
"docs": "https://quo.com/docs",
"title": "Subscription Expired",
"trace": "6897907457496870895"
}{
"message": "You must be an organization admin or owner to create an A2P registration",
"docs": "https://quo.com/docs",
"title": "Forbidden",
"trace": "6897907457496870895"
}{
"message": "Not Found",
"docs": "https://quo.com/docs",
"title": "Not Found",
"trace": "6897907457496870895"
}{
"message": "This organization already has an A2P registration",
"docs": "https://quo.com/docs",
"title": "Conflict",
"trace": "6897907457496870895"
}{
"message": "idNumber must contain exactly nine digits for idType USA: Employer Identification Number (EIN)",
"docs": "https://quo.com/docs",
"title": "Unprocessable Entity",
"trace": "6897907457496870895"
}{
"message": "We have encountered an unknown error",
"docs": "https://quo.com/docs",
"title": "Unexpected",
"trace": "6897907457496870895"
}Headers
Body
The legal structure of the business: one of Sole Proprietorship, Partnership, Corporation, Co-operative, Limited Liability Corporation, Non-profit Corporation.
"Sole Proprietorship""Limited Liability Corporation"
The industry the business operates in: one of Agriculture, Automotive, Banking, Consumer, Education, Electronics, Energy, Engineering, Fast moving consumer goods, Financial, Fintech, Food and beverage, Government, Healthcare, Hospitality, Insurance, Jewelry, Legal, Manufacturing, Media, Not for profit, Oil and gas, Online, Raw materials, Real estate, Religion, Retail, Technology, Telecommunications, Transportation, Travel.
"Agriculture""Technology"
The type of the business's government-issued tax ID: one of USA: Employer Identification Number (EIN), Canada: Canadian Business Number (BN-9), Great Britain: Company Number, Australia: Company Number from ASIC (ACN), India: Corporate Identity Number, Estonia: VAT Number, Romania: VAT Registration Number, Israel: Registration Number, Other.
"USA: Employer Identification Number (EIN)""USA: Employer Identification Number (EIN)"
The message-use types that autofill uses for this request. The registration does not store this value: send it again on any later request that starts autofill.
1"appointments_scheduling"[
"customer_support",
"transactional_notifications"
]
The stock exchange the business's ticker is listed on. Required when companyType is Public. One of NASDAQ, NYSE, AMEX, AMX, ASX, B3, BME, BSE, FRA, ICEX, JPX, JSE, KRX, LON, NSE, OMX, SEHK, SGX, SSE, STO, SWX, SZSE, TSX, TWSE, VSE, Other.
"NASDAQ""NASDAQ"
Was this page helpful?