{"note":"OpenAPI conversion -- returning structured metadata","name":"twilio-accounts","description":"Twilio - Accounts","version":"1.0.0","base_url":"https://accounts.twilio.com","endpoints":21,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Twilio - Accounts\n@base https://accounts.twilio.com\n@version 1.0.0\n@auth Bearer basic\n@endpoints 21\n@hint download_for_search\n@toc AuthTokens(3), ComplianceSignals(1), Consents(1), Contacts(1), Credentials(10), Messaging(2), SafeList(3)\n\n@group AuthTokens\n@endpoint POST /v1/AuthTokens/Promote\n@desc Promote the secondary Auth Token to primary. After promoting the new token, all requests to Twilio using your old primary Auth Token will result in an error.\n@returns(200) {account_sid: str?, auth_token: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?} # OK\n\n@endgroup\n\n@group ComplianceSignals\n@endpoint POST /v1/ComplianceSignals/Check\n@desc Evaluate compliance signals for a message\n@required {signals: [str] # The signals to evaluate. Only `QUIET_HOURS` is supported., to: str # The recipient phone number in [E.164 format](https://www.twilio.com/docs/glossary/what-e164)., countryIsoCode: str # The ISO 3166-1 alpha-2 country of the recipient. Only `US` is supported.}\n@optional {body: str # The content of the message, at most 1600 characters. Required if `useCase` is not provided., useCase: str # The intent of the message, one of `OTP`, `NOTIFICATIONS`, `FRAUD`, `SECURITY`, `CUSTOMERCARE`, `DELIVERY`, `EDUCATION`, `EVENTS`, `POLLING`, `ANNOUNCEMENTS` or `MARKETING`. Required if `body` is not provided. It is used instead of the body when both are given., channel: str # The channel the message is sent on, one of `SMS`, `MMS`, `RCS` or `CALL`. Defaults to `SMS`., zipCode: str # The US zip code of the recipient, 5 digits or ZIP+4. When it is not given or not known, the location is inferred from the phone number., sendAt: str # An [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) timestamp, in UTC or with an offset, to evaluate a scheduled delivery instead of the current time. It must not be in the past.}\n@returns(200) {signals: map?{quietHours: map?{isActive: bool, reason: str, evaluatedUseCase: str?, location: map{countryIsoCode: str?, stateCode: str?}, sendingWindow: map?{startAt: str(date-time), endAt: str(date-time)}}}} # OK\n@errors {400: Invalid request. The detail lists the failed checks, for example `INVALID_SIGNALS`, `INVALID_TO_NUMBER`, `BODY_OR_USE_CASE_REQUIRED`, `BODY_TOO_LONG`, `INVALID_USE_CASE`, `INVALID_CHANNEL`, `COUNTRY_ISO_CODE_REQUIRED`, `INVALID_DESTINATION_COUNTRY`, `INVALID_ZIP_CODE` or `INVALID_SEND_AT`., 415: Unsupported media type. The Content-Type header is not application/json., 429: Too many requests., 500: Internal server error.}\n@example_request {\"signals\":[\"QUIET_HOURS\"],\"to\":\"+16502530000\",\"useCase\":\"MARKETING\",\"countryIsoCode\":\"US\",\"zipCode\":\"33101\",\"sendAt\":\"2099-04-15T16:00:00Z\"}\n\n@endgroup\n\n@group Consents\n@endpoint POST /v1/Consents/Bulk\n@returns(201) {items: any?} # Created\n\n@endgroup\n\n@group Contacts\n@endpoint POST /v1/Contacts/Bulk\n@returns(201) {items: any?} # Created\n\n@endgroup\n\n@group Credentials\n@endpoint GET /v1/Credentials/AWS\n@desc Retrieves a collection of AWS Credentials belonging to the account used to make the request\n@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 1000., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {credentials: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endpoint POST /v1/Credentials/AWS\n@desc Create a new AWS Credential\n@returns(201) {sid: str?, account_sid: str?, friendly_name: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?} # Created\n\n@endpoint GET /v1/Credentials/AWS/{Sid}\n@desc Fetch the AWS credentials specified by the provided Credential Sid\n@required {Sid: str # The Twilio-provided string that uniquely identifies the AWS resource to fetch.}\n@returns(200) {sid: str?, account_sid: str?, friendly_name: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?} # OK\n\n@endpoint POST /v1/Credentials/AWS/{Sid}\n@desc Modify the properties of a given Account\n@required {Sid: str # The Twilio-provided string that uniquely identifies the AWS resource to update.}\n@returns(200) {sid: str?, account_sid: str?, friendly_name: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?} # OK\n\n@endpoint DELETE /v1/Credentials/AWS/{Sid}\n@desc Delete a Credential from your account\n@required {Sid: str # The Twilio-provided string that uniquely identifies the AWS resource to delete.}\n@returns(204) The resource was deleted successfully.\n\n@endpoint GET /v1/Credentials/PublicKeys\n@desc Retrieves a collection of Public Key Credentials belonging to the account used to make the request\n@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 1000., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {credentials: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endpoint POST /v1/Credentials/PublicKeys\n@desc Create a new Public Key Credential\n@returns(201) {sid: str?, account_sid: str?, friendly_name: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?} # Created\n\n@endpoint GET /v1/Credentials/PublicKeys/{Sid}\n@desc Fetch the public key specified by the provided Credential Sid\n@required {Sid: str # The Twilio-provided string that uniquely identifies the PublicKey resource to fetch.}\n@returns(200) {sid: str?, account_sid: str?, friendly_name: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?} # OK\n\n@endpoint POST /v1/Credentials/PublicKeys/{Sid}\n@desc Modify the properties of a given Account\n@required {Sid: str # The Twilio-provided string that uniquely identifies the PublicKey resource to update.}\n@returns(200) {sid: str?, account_sid: str?, friendly_name: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?} # OK\n\n@endpoint DELETE /v1/Credentials/PublicKeys/{Sid}\n@desc Delete a Credential from your account\n@required {Sid: str # The Twilio-provided string that uniquely identifies the PublicKey resource to delete.}\n@returns(204) The resource was deleted successfully.\n\n@endgroup\n\n@group Messaging\n@endpoint PATCH /v1/Messaging/GeoPermissions\n@returns(200) {permissions: any?} # OK\n\n@endpoint GET /v1/Messaging/GeoPermissions\n@optional {CountryCode: str # The country code to filter the geo permissions. If provided, only the geo permission for the specified country will be returned.}\n@returns(200) {permissions: any?} # OK\n\n@endgroup\n\n@group SafeList\n@endpoint POST /v1/SafeList/Numbers\n@desc Add a new phone number or phone number 1k prefix to SafeList.\n@returns(201) {sid: str?, phone_number: str?} # Created\n\n@endpoint GET /v1/SafeList/Numbers\n@desc Check if a phone number or phone number 1k prefix exists in SafeList.\n@optional {PhoneNumber: str # The phone number or phone number 1k prefix to be fetched from SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).}\n@returns(200) {sid: str?, phone_number: str?} # OK\n\n@endpoint DELETE /v1/SafeList/Numbers\n@desc Remove a phone number or phone number 1k prefix from SafeList.\n@optional {PhoneNumber: str # The phone number or phone number 1k prefix to be removed from SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).}\n@returns(204) The resource was deleted successfully.\n\n@endgroup\n\n@group AuthTokens\n@endpoint POST /v1/AuthTokens/Secondary\n@desc Create a new secondary Auth Token\n@returns(201) {account_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, secondary_auth_token: str?, url: str(uri)?} # Created\n\n@endpoint DELETE /v1/AuthTokens/Secondary\n@desc Delete the secondary Auth Token from your account\n@optional {SuppressEmailNotification: bool # Whether to suppress the email notification that Twilio sends to the owners and administrators of the account about this Auth Token change. Defaults to `false`, so Twilio sends the email. Set to `true` when rotating Auth Tokens across many subaccounts.}\n@returns(204) The resource was deleted successfully.\n\n@endgroup\n\n@end\n"}