Register a company

1 curl -X POST https://www.trypinnacle.dev/api/company/register \ 2 -H "PINNACLE-API-Key: <apiKey>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "company": { 6 "name": "name", 7 "category": "Entertainment", 8 "address": "address", 9 "ein": "ein", 10 "description": "description", 11 "brandColor": "brandColor", 12 "logoUrl": "logoUrl", 13 "heroUrl": "heroUrl" 14 }, 15 "companyContact": { 16 "primaryWebsiteUrl": "primaryWebsiteUrl", 17 "primaryWebsiteLabel": "primaryWebsiteLabel", 18 "primaryPhone": "primaryPhone", 19 "primaryPhoneLabel": "primaryPhoneLabel", 20 "primaryEmail": "primaryEmail", 21 "primaryEmailLabel": "primaryEmailLabel", 22 "privacyPolicyUrl": "privacyPolicyUrl", 23 "tosUrl": "tosUrl" 24 }, 25 "messaging": { 26 "optIn": "By opting in, you agree to receive messages from Pinnacle, including updates and promotions. Reply “STOP” to unsubscribe. Standard message and data rates may apply.", 27 "optOut": "Reply with keywords like STOP or UNSUBSCRIBE to opt-out. A confirmation message will be sent, and no further messages will be received unless you re-subscribe.", 28 "optOutKeywords": [ 29 "STOP", 30 "UNSUBSCRIBE" 31 ], 32 "agentUseCase": "Pinnacle’s agent assists with product updates, promotions, order tracking, and support. It answers FAQs, provides order updates, and helps with opt-in/out processes. Escalates to live support when needed.", 33 "expectedAgentResponses": "General Inquiry: “How can I assist you today?”\nOrder Status: “Provide your order number.”\nOpt-In: “You’re now subscribed!”\nOpt-Out: “You have unsubscribed.”\nEscalation: “Connecting to a live agent.” \n" 34 }, 35 "pointOfContact": { 36 "pocName": "pocName", 37 "pocTitle": "pocTitle", 38 "pocEmail": "pocEmail" 39 } 40 }'

1 { 2 "brand": { 3 "name": "Test Company", 4 "id": 36 5 } 6 }

Request

This endpoint expects an object.

companyobjectRequired

companyContactobjectRequired

messagingobjectRequired

pointOfContactobjectRequired

optionalsobjectOptional

Response

Successfully registered/updated brand

brandobject

Headers

Request

Response

Errors