Settings
PATCH /accounts/:account
Examples
Changing an account setting
Request
PATCH /accounts/my_account
Body
{
"settings": {
"inboundMmsDisabled": {
"value": false
},
"forwardingNumber": {
"value": "5555555555"
}, "campaignDeliveryCutoffTime": { "value": 460
},
"campaignDeliveryCutoffTimeEnabled": {
"value": true
},
"autoReplyMessageEnabled": {
"value": true
},
"autoReplyMessage": {
"value": {
"officeHours": false,
"message": "This is an automated reply."
}
},
"companyName": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"companyFooter": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"product": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
}
}
}
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
-H Authorization:"Bearer {token}" \
-X PATCH /accounts/my_account
-d '{
"settings": {
"inboundMmsDisabled": {
"value": false
},
"forwardingNumber": {
"value": "5555555555"
}, "campaignDeliveryCutoffTime": { "value": 460
},
"campaignDeliveryCutoffTimeEnabled": {
"value": true
},
"autoReplyMessageEnabled": {
"value": true
},
"autoReplyMessage": {
"value": {
"officeHours": false,
"message": "This is an automated reply."
}
},
"companyName": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"companyFooter": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"product": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
}
}
}'
Response
Status
200
Response Type
Example Body
{
"@type": "Account",
"@context": "/contexts/Account.jsonld",
"id": "/accounts/child_account",
"name": "child_account",
"slug": "child_account",
"shortenedLinkDomain": "textus.textlink.us",
"shortenedLinkPreviewUrl": "https:/textus.textlink.us/#",
"multiUser": false,
"effectiveRole": "admin",
"messagingRestricted": true,
"type": "standard",
"contactImport": "/child_account/contacts/import",
"contacts": "/child_account/contacts",
"conversationFilters": "/child_account/conversation_filters",
"campaignFilters": "/child_account/campaign_filters",
"contactFilters": "/child_account/contact_filters",
"conversations": "/child_account/conversations/{phoneNumber}{?contactPhone}",
"inbox": "/child_account/inbox",
"campaigns": "/child_account/campaigns",
"presignAttachment": "/child_account/attachments/sign",
"presignContactImport": "/child_account/contacts/import/generate_signed_url",
"presignMessageImport": "/child_account/messages/import/generate_signed_url",
"contactPhones": "/child_account/contact_phones",
"sendMessages": "/child_account/messages",
"scheduleMessages": "/child_account/messages/schedule",
"users": "/child_account/users",
"navbar": "/navbar/child_account",
"signedAvatarUrl": "/users/signed_avatar_url",
"children": "/accounts/child_account/children",
"analytics": "/accounts/my_account/analytics",
"optOutAnalytics": "/my_account/opt_outs/analytics",
"optOuts": "/my_account/opt_outs",
"exportOptOuts": "/my_account/opt_outs/export",
"optOutImport": "/my_account/opt_outs/upload",
"presignOptOutImport": "/my_account/opt_outs/sign",
"userSchema": "/textus/user_schema",
"organizationAccount": null,
"premiumSupportUrl": null,
"adminUserSchema": null,
"logo": null,
"familyCount": 1,
"childrenCount": 0,
"featureFlags": {
"whiteLabelEnabled": false,
"hideAnalyticsExport": false,
"bligeAddContactMatching": false,
"billingPageWithCumulative": false,
"greenhouseV3": false,
"campaignDailyOverages": false,
"automatedSender": false,
"accountConfigurationRework": false,
"inboxContactsRedesign": false,
"campaignsResponsiveness": false,
"contactDeduplication2": false
},
"signedWhitelabelUrl": "/accounts/signed_whitelabel_url",
"phoneNumbers": [
"(303) 555-1111"
],
"integrations": "/my_account/integrations",
"contactsEnabled": true,
"settings": {
"maxCampaignRecipients": {
"value": 100,
"locked": false,
"setAtAccount": "/accounts/my_account",
"lockedAtAccount": {
"id": null,
"name": null
},
"disabled": false
},
"dailyCampaignRecipients": {
"value": 100,
"locked": false,
"setAtAccount": "/accounts/my_account",
"lockedAtAccount": {
"id": null,
"name": null
},
"disabled": false
},
"conversationAutoCloseAfter": {
"disabled": false,
"locked": false,
"lockedAtAccount": {
"id": null,
"name": null
},
"setAtAccount": "/accounts/my_account",
"value": -1
},
"countryCode": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"contactImportTarget": {
"setAtAccount": "/accounts/my_account",
"disabled": false,
"value": true,
"locked": false,
"lockedAtAccount": {
"id": null,
"name": null
}
},
"unassignClosedConversationsAfter": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"unassignOpenConversationsAfter": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"forwardingNumberDisabled": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"forwardingNumber": {
"value": "5555555555",
"locked": false,
"lockedAtAccount": {
"id": null,
"name": null
},
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"inboundMmsDisabled": {
"value": false,
"locked": false,
"lockedAtAccount": {
"id": null,
"name": null
},
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"outboundMmsDisabled": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"stripInboundLinks": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"stripOutboundLinks": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"introMessages": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"officeHours": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"campaignDeliveryCutoffTime": {
"value": 460,
"locked": false,
"lockedAtAccount": {
"id": null,
"name": null
},
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"campaignDeliveryCutoffTimeEnabled": {
"value": true,
"locked": false,
"lockedAtAccount": {
"id": null,
"name": null
},
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"timeZone": {
"value": "US/Mountain",
"locked": false,
"lockedAtAccount": {
"id": null,
"name": null
},
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"avaloId": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"voiceEnabled": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"conversationExportsEnabled": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"logo": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"mobileLogo": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"primaryColor": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"secondaryColor": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"tertiaryColor": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"outboundMessageColor": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"accountImageUrl": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"sharedOptOutsTarget": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"legalEntity": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"appendedMessageDefaults": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"conversationAppendedMessages": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"campaignAppendedMessages": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"autoReplyMessageEnabled": {
"disabled": false,
"setAtAccount": "/accounts/my_account",
"value": true,
"locked": false,
"lockedAtAccount": {
"id": null,
"name": null
}
},
"autoReplyMessage": {
"disabled": false,
"setAtAccount": "/accounts/my_account",
"value": {
"message": "This is an automated reply.",
"officeHours": true
},
"locked": false,
"lockedAtAccount": {
"id": null,
"name": null
}
},
"companyName": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"companyFooter": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"product": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"supportLink": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"preferredDomain": {
"disabled": false,
"setAtAccount": "/accounts/my_account",
"value": "www.example.com",
"locked": false,
"lockedAtAccount": {
"id": null,
"name": null
}
},
"email": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"resellerId": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"registeredLinks": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"exclusionTimeEnabled": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"exclusionTime": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"conversationMaxMessageLength": {
"disabled": false,
"setAtAccount": "/accounts/my_account",
"value": 480,
"locked": false,
"lockedAtAccount": {
"id": null,
"name": null
}
},
"campaignMaxMessageLength": {
"disabled": false,
"setAtAccount": "/accounts/my_account",
"value": 480,
"locked": false,
"lockedAtAccount": {
"id": null,
"name": null
}
},
"mmsDisabled": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"messagingManuallyDisabled": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"automationKeywordMaxKeywordLimit": {
"disabled": false,
"setAtAccount": "/accounts/my_account",
"value": 100,
"locked": false,
"lockedAtAccount": {
"id": null,
"name": null
}
},
"accountNameChangeDisabled": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"automatedSenderId": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
}
},
"hasCumulativePlan": false
}
Removing an account setting
Request
PATCH /accounts/my_account
Body
{
"settings": {
"autoReplyMessageEnabled": {
"value": null
}
}
}
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
-H Authorization:"Bearer {token}" \
-X PATCH /accounts/my_account
-d '{
"settings": {
"autoReplyMessageEnabled": {
"value": null
}
}
}'
Response
Status
200
Response Type
Example Body
{
"@type": "Account",
"@context": "/contexts/Account.jsonld",
"id": "/accounts/child_account",
"name": "child_account",
"slug": "child_account",
"shortenedLinkDomain": "textus.textlink.us",
"shortenedLinkPreviewUrl": "https:/textus.textlink.us/#",
"multiUser": false,
"effectiveRole": "admin",
"messagingRestricted": true,
"type": "standard",
"contactImport": "/child_account/contacts/import",
"contacts": "/child_account/contacts",
"conversationFilters": "/child_account/conversation_filters",
"campaignFilters": "/child_account/campaign_filters",
"contactFilters": "/child_account/contact_filters",
"conversations": "/child_account/conversations/{phoneNumber}{?contactPhone}",
"inbox": "/child_account/inbox",
"campaigns": "/child_account/campaigns",
"presignAttachment": "/child_account/attachments/sign",
"presignContactImport": "/child_account/contacts/import/generate_signed_url",
"presignMessageImport": "/child_account/messages/import/generate_signed_url",
"contactPhones": "/child_account/contact_phones",
"sendMessages": "/child_account/messages",
"scheduleMessages": "/child_account/messages/schedule",
"users": "/child_account/users",
"navbar": "/navbar/child_account",
"signedAvatarUrl": "/users/signed_avatar_url",
"children": "/accounts/child_account/children",
"analytics": "/accounts/my_account/analytics",
"optOutAnalytics": "/my_account/opt_outs/analytics",
"optOuts": "/my_account/opt_outs",
"exportOptOuts": "/my_account/opt_outs/export",
"optOutImport": "/my_account/opt_outs/upload",
"presignOptOutImport": "/my_account/opt_outs/sign",
"userSchema": "/textus/user_schema",
"organizationAccount": null,
"premiumSupportUrl": null,
"adminUserSchema": null,
"logo": null,
"familyCount": 1,
"childrenCount": 0,
"featureFlags": {
"whiteLabelEnabled": false,
"hideAnalyticsExport": false,
"bligeAddContactMatching": false,
"billingPageWithCumulative": false,
"greenhouseV3": false,
"campaignDailyOverages": false,
"automatedSender": false,
"accountConfigurationRework": false,
"inboxContactsRedesign": false,
"campaignsResponsiveness": false,
"contactDeduplication2": false
},
"signedWhitelabelUrl": "/accounts/signed_whitelabel_url",
"phoneNumbers": [
"(303) 555-1111"
],
"integrations": "/my_account/integrations",
"contactsEnabled": true,
"settings": {
"maxCampaignRecipients": {
"value": 100,
"locked": false,
"lockedAtAccount": {
"id": null,
"name": null
},
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"dailyCampaignRecipients": {
"value": 500,
"locked": false,
"lockedAtAccount": {
"id": null,
"name": null
},
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"conversationAutoCloseAfter": {
"value": -1,
"locked": false,
"lockedAtAccount": {
"id": null,
"name": null
},
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"countryCode": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"contactImportTarget": {
"setAtAccount": "/accounts/my_account",
"disabled": false,
"value": true,
"locked": false,
"lockedAtAccount": {
"id": null,
"name": null
}
},
"unassignClosedConversationsAfter": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"unassignOpenConversationsAfter": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"forwardingNumberDisabled": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"forwardingNumber": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"inboundMmsDisabled": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"outboundMmsDisabled": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"stripInboundLinks": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"stripOutboundLinks": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"introMessages": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"officeHours": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"campaignDeliveryCutoffTime": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"campaignDeliveryCutoffTimeEnabled": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"timeZone": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"avaloId": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"voiceEnabled": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"conversationExportsEnabled": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"logo": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"mobileLogo": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"primaryColor": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"secondaryColor": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"tertiaryColor": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"outboundMessageColor": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"accountImageUrl": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"sharedOptOutsTarget": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"legalEntity": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"appendedMessageDefaults": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"conversationAppendedMessages": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"campaignAppendedMessages": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"autoReplyMessageEnabled": {
"setAtAccount": "/accounts/my_account",
"disabled": false,
"locked": true,
"lockedAtAccount": {
"id": "/accounts/my_account",
"name": "Example Account"
}
},
"autoReplyMessage": {
"setAtAccount": "/accounts/my_account",
"disabled": false
},
"companyName": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"companyFooter": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"product": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"supportLink": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"preferredDomain": {
"disabled": false,
"setAtAccount": "/accounts/my_account",
"value": "www.example.com",
"locked": false,
"lockedAtAccount": {
"id": null,
"name": null
}
},
"email": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"resellerId": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"registeredLinks": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"exclusionTimeEnabled": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"exclusionTime": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"conversationMaxMessageLength": {
"disabled": false,
"setAtAccount": "/accounts/my_account",
"value": 480,
"locked": false,
"lockedAtAccount": {
"id": null,
"name": null
}
},
"campaignMaxMessageLength": {
"disabled": false,
"setAtAccount": "/accounts/my_account",
"value": 480,
"locked": false,
"lockedAtAccount": {
"id": null,
"name": null
}
},
"mmsDisabled": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"messagingManuallyDisabled": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"automationKeywordMaxKeywordLimit": {
"disabled": false,
"setAtAccount": "/accounts/my_account",
"value": 100,
"locked": false,
"lockedAtAccount": {
"id": null,
"name": null
}
},
"accountNameChangeDisabled": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
},
"automatedSenderId": {
"disabled": false,
"setAtAccount": "/accounts/my_account"
}
},
"hasCumulativePlan": false
}
Changing a locked account setting
Request
PATCH /accounts/my_account
Body
{
"settings": {
"autoReplyMessageEnabled": {
"value": false,
"locked": true
}
}
}
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
-H Authorization:"Bearer {token}" \
-X PATCH /accounts/my_account
-d '{
"settings": {
"autoReplyMessageEnabled": {
"value": false,
"locked": true
}
}
}'
Response
Status
403
Response Type
No body