Update the organization's settings
const url = 'https://example.com/api/organizations/settings';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"name":"Community Food Pantry","legalName":"Multiply Church, Inc.","slug":"hope-community-center","shortCode":"DCC","orgStatus":"ENABLED","maxConcurrency":5,"tcrStatus":"APPROVED","tcrBrandStatus":"unregistered","tcrCampaignStatus":"unregistered","phoneStatus":"unassigned","profileStatus":"unconfigured","tcrBrandId":"B1234567","tcrCampaignId":"C1234567","provisioningError":"Failed to create 10DLC brand: API error (402): Insufficient Funds","redirectPhoneNumber":"+18005550100","einTaxId":"12-3456789","dailySmsCap":2000,"monthlySmsBudget":50000,"quietHoursEnabled":true,"quietHoursStart":"21:00","quietHoursEnd":"07:00","bypassQuietHoursForEmergency":true,"smsSenderName":"DreamCenter","supportEmail":"[email protected]","supportPhone":"+17045550199","street":"24 Junction Pkwy MEM","city":"Concord","state":"NC","zip":"28027","legalStreet":"280 Rone Avenue","legalCity":"Concord","legalState":"NC","legalZip":"28025"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://example.com/api/organizations/settings \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "Community Food Pantry", "legalName": "Multiply Church, Inc.", "slug": "hope-community-center", "shortCode": "DCC", "orgStatus": "ENABLED", "maxConcurrency": 5, "tcrStatus": "APPROVED", "tcrBrandStatus": "unregistered", "tcrCampaignStatus": "unregistered", "phoneStatus": "unassigned", "profileStatus": "unconfigured", "tcrBrandId": "B1234567", "tcrCampaignId": "C1234567", "provisioningError": "Failed to create 10DLC brand: API error (402): Insufficient Funds", "redirectPhoneNumber": "+18005550100", "einTaxId": "12-3456789", "dailySmsCap": 2000, "monthlySmsBudget": 50000, "quietHoursEnabled": true, "quietHoursStart": "21:00", "quietHoursEnd": "07:00", "bypassQuietHoursForEmergency": true, "smsSenderName": "DreamCenter", "supportEmail": "[email protected]", "supportPhone": "+17045550199", "street": "24 Junction Pkwy MEM", "city": "Concord", "state": "NC", "zip": "28027", "legalStreet": "280 Rone Avenue", "legalCity": "Concord", "legalState": "NC", "legalZip": "28025" }'Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
Full display name of the resource, facility, or individual.
Example
Community Food PantryLegal corporate entity name registered with the IRS for EIN tax verification and 10DLC compliance.
Example
Multiply Church, Inc.URL-friendly unique slug identifier.
Example
hope-community-centerUnique 4 to 6 character uppercase short code.
Example
DCCLifecycle operational status of the organization tenant (ENABLED or DISABLED).
Maximum allowed concurrent SMS messaging connections.
Example
5The Campaign Registry (TCR) 10DLC registration status.
Example
APPROVEDGranular status of 10DLC Brand registration.
Granular status of 10DLC Campaign registration.
Granular status of phone number assignment.
Granular status of messaging profile and vault setup.
Registered 10DLC Brand ID.
Example
B1234567Registered 10DLC Campaign ID.
Example
C1234567Error message from the latest telephony provisioning attempt.
Example
Failed to create 10DLC brand: API error (402): Insufficient FundsConfigured human operator redirect phone number.
Example
+18005550100Legal 501(c)(3) EIN Tax Identifier.
Example
12-3456789Maximum allowed outbound SMS dispatches per day.
Example
2000Monthly SMS dispatch cap budget.
Example
50000Whether non-emergency outbound messaging is paused during night hours.
Example
trueStart time for quiet hours window.
Example
21:00End time for quiet hours window.
Example
07:00Whether emergency triage alerts bypass quiet hours.
Example
trueBrand display name prepended to outgoing broadcast SMS.
Example
DreamCenterSupport hotline phone populating automated HELP responses.
Example
+17045550199Physical street address line.
Example
24 Junction Pkwy MEMCity name.
Example
ConcordState or province code.
Example
NCZIP or postal code.
Example
28027Official registered physical headquarters address line matching IRS/state tax records.
Example
280 Rone AvenueOfficial registered city matching IRS/state tax records.
Example
ConcordOfficial registered two-letter state matching IRS/state tax records.
Example
NCOfficial registered ZIP postal code matching IRS/state tax records.
Example
28025Responses
Section titled “Responses”Organization settings updated successfully
object
Unique identifier (UUID v4) for the resource.
Full display name of the resource, facility, or individual.
Legal corporate entity name registered with the IRS for EIN tax verification and 10DLC compliance.
URL-friendly unique slug identifier.
Unique 4 to 6 character uppercase short code.
Lifecycle operational status of the organization tenant (ENABLED or DISABLED).
Maximum allowed concurrent SMS messaging connections.
The Campaign Registry (TCR) 10DLC registration status.
Granular status of 10DLC Brand registration.
Granular status of 10DLC Campaign registration.
Granular status of phone number assignment.
Granular status of messaging profile and vault setup.
Registered 10DLC Brand ID.
Registered 10DLC Campaign ID.
Error message from the latest telephony provisioning attempt.
Map of individual step names to specific error details.
object
Provisioned system phone number.
Configured human operator redirect phone number.
Legal 501(c)(3) EIN Tax Identifier for 10DLC discount verification.
Maximum allowed outbound SMS dispatches per day.
Monthly SMS dispatch cap budget.
Whether non-emergency outbound messaging is paused during night hours.
Start time for quiet hours window (HH:mm).
End time for quiet hours window (HH:mm).
Whether emergency triage alerts bypass quiet hours.
Brand display name prepended to outgoing broadcast SMS.
Support email populating automated HELP responses.
Support hotline phone populating automated HELP responses.
Physical street address line.
City name.
State or province code.
ZIP or postal code.
Official registered physical headquarters address line matching IRS/state tax records.
Official registered city matching IRS/state tax records.
Official registered two-letter state matching IRS/state tax records.
Official registered ZIP postal code matching IRS/state tax records.
Example
{ "id": "a1b2c3d4-e5f6-7890-abcd-1234567890ab", "name": "Community Food Pantry", "legalName": "Multiply Church, Inc.", "slug": "hope-community-center", "shortCode": "DCC", "orgStatus": "ENABLED", "maxConcurrency": 5, "tcrStatus": "APPROVED", "tcrBrandStatus": "unregistered", "tcrCampaignStatus": "unregistered", "phoneStatus": "unassigned", "profileStatus": "unconfigured", "tcrBrandId": "B1234567", "tcrCampaignId": "C1234567", "provisioningError": "Failed to create 10DLC brand: API error (402): Insufficient Funds", "phoneNumber": "+17045550100", "redirectPhoneNumber": "+18005550100", "einTaxId": "12-3456789", "dailySmsCap": 2000, "monthlySmsBudget": 50000, "quietHoursEnabled": true, "quietHoursStart": "21:00", "quietHoursEnd": "07:00", "bypassQuietHoursForEmergency": true, "smsSenderName": "DreamCenter", "supportPhone": "+17045550199", "street": "24 Junction Pkwy MEM", "city": "Concord", "state": "NC", "zip": "28027", "legalStreet": "280 Rone Avenue", "legalCity": "Concord", "legalState": "NC", "legalZip": "28025"}Invalid request
Unauthorized
Forbidden