openapi: 3.0.0 info: version: 10.24.29 title: SMS API description: "Welcome to the SMS API.\n\nYou can use this API to access all SMS API endpoints.\n\n## Base URL\n\nThe base URL for all API requests is `https://unify.apideck.com`\n\n## Headers\n\nCustom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230) states header names are case insensitive.\n\n| Name | Type | Required | Description |\n| --------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| x-apideck-consumer-id | String | Yes | The id of the customer stored inside Apideck Vault. This can be a user id, account id, device id or whatever entity that can have integration within your app. |\n| x-apideck-service-id | String | No | Describe the service you want to call (e.g., pipedrive). Only needed when a customer has activated multiple integrations for the same Unified API. |\n| x-apideck-app-id | String | Yes | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys. |\n| Authorization | String | Yes | Bearer KEY |\n\n## Authorization\n\nYou can interact with the API through the authorization methods below.\n\n\n\n## Pagination\n\nAll API resources have support for bulk retrieval via list APIs. Apideck uses cursor-based pagination via the optional `cursor` and `limit` parameters.\n\nTo fetch the first page of results, call the list API without a `cursor` parameter. Afterwards you can fetch subsequent pages by providing a cursor parameter. You will find the next cursor in the response body in `meta.cursors.next`. If `meta.cursors.next` is `null` you're at the end of the list.\n\nIn the REST API you can also use the `links` from the response for added convenience. Simply call the URL in `links.next` to get the next page of results.\n\n### Query Parameters\n\n| Name | Type | Required | Description |\n| ------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------ |\n| cursor | String | No | Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response. |\n| limit | Number | No | Number of results to return. Minimum 1, Maximum 200, Default 20 |\n\n### Response Body\n\n| Name | Type | Description |\n| --------------------- | ------ | ------------------------------------------------------------------ |\n| meta.cursors.previous | String | Cursor to navigate to the previous page of results through the API |\n| meta.cursors.current | String | Cursor to navigate to the current page of results through the API |\n| meta.cursors.next | String | Cursor to navigate to the next page of results through the API |\n| meta.items_on_page | Number | Number of items returned in the data property of the response |\n| links.previous | String | Link to navigate to the previous page of results through the API |\n| links.current | String | Link to navigate to the current page of results through the API |\n| links.next | String | Link to navigate to the next page of results through the API |\n\n⚠️ `meta.cursors.previous`/`links.previous` is not available for all connectors.\n\n## SDKs and API Clients\n\nWe currently offer a [Node.js](https://developers.apideck.com/sdks/node), [PHP](https://developers.apideck.com/sdks/php), [Python](https://developers.apideck.com/sdks/python) and [.NET](https://developers.apideck.com/sdks/dot-net) SDK.\nNeed another SDK? [Request the SDK of your choice](https://requests.apideck.io/request).\n\n## Debugging\n\nBecause of the nature of the abstraction we do in Apideck Unify we still provide the option to the receive raw requests and responses being handled underlying. By including the raw flag `?raw=true` in your requests you can still receive the full request. Please note that this increases the response size and can introduce extra latency.\n\n## Errors\n\nThe API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below.\n\n| Code | Title | Description |\n| ---- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| 200 | OK | The request message has been successfully processed, and it has produced a response. The response message varies, depending on the request method and the requested data. |\n| 201 | Created | The request has been fulfilled and has resulted in one or more new resources being created. |\n| 204 | No Content | The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. |\n| 400 | Bad Request | The receiving server cannot understand the request because of malformed syntax. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request. |\n| 401 | Unauthorized | The request has not been applied because it lacks valid authentication credentials for the target resource. |\n| 402 | Payment Required | Subscription data is incomplete or out of date. You'll need to provide payment details to continue. |\n| 403 | Forbidden | You do not have the appropriate user rights to access the request. Do not repeat the request. |\n| 404 | Not Found | The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. |\n| 409 | Conflict | The request could not be completed due to a conflict with the current state of the target resource. |\n| 422 | Unprocessable Entity | The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions. |\n| 429 | Too Many Requests | You sent too many requests in a given amount of time (\"rate limit\"). Try again later |\n| 5xx | Server Errors | Something went wrong with the Unify API. These errors are logged on our side. You can contact our team to resolve the issue. |\n\n### Handling errors\n\nThe Unify API and SDKs can produce errors for many reasons, such as a failed requests due to misconfigured integrations, invalid parameters, authentication errors, and network unavailability.\n\n### Error Types\n\n#### RequestValidationError\n\nRequest is not valid for the current endpoint. The response body will include details on the validation error. Check the spelling and types of your attributes, and ensure you are not passing data that is outside of the specification.\n\n#### UnsupportedFiltersError\n\nFilters in the request are valid, but not supported by the connector. Remove the unsupported filter(s) to get a successful response.\n\n#### UnsupportedSortFieldError\n\nSort field (`sort[by]`) in the request is valid, but not supported by the connector. Replace or remove the sort field to get a successful response.\n\n#### InvalidCursorError\n\nPagination cursor in the request is not valid for the current connector. Make sure to use a cursor returned from the API, for the same connector.\n\n#### ConnectorExecutionError\n\nA Unified API request made via one of our downstream connectors returned an unexpected error. The `status_code` returned is proxied through to error response along with their original response via the error detail.\n\n#### UnauthorizedError\n\nWe were unable to authorize the request as made. This can happen for a number of reasons, from missing header params to passing an incorrect authorization token. Verify your Api Key is being set correctly in the authorization header. ie: `Authorization: 'Bearer '`\n\n#### ConnectorCredentialsError\n\nA request using a given connector has not been authorized. Ensure the connector you are trying to use has been configured correctly and been authorized for use.\n\n#### ConnectorDisabledError\n\nA request has been made to a connector that has since been disabled. This may be temporary - You can contact our team to resolve the issue.\n\n#### ConnectorRateLimitError\n\nYou sent too many request to a connector. These rate limits vary from connector to connector. You will need to try again later.\n\n#### RequestLimitError\n\nYou have reached the number of requests included in your Free Tier Subscription. You will not be able to make further requests until you upgrade your subscription. Please reach out to sales@apideck.com to continue making requests.\n\n#### EntityNotFoundError\n\nYou've made a request for a resource or route that does not exist. Verify your path parameters or any identifiers used to fetch this resource.\n\n#### OAuthCredentialsNotFoundError\n\nWhen adding a connector integration that implements OAuth, both a `client_id` and `client_secret` must be provided before any authorizations can be performed. Verify the integration has been configured properly before continuing.\n\n#### IntegrationNotFoundError\n\nThe requested connector integration could not be found associated to your `application_id`. Verify your `application_id` is correct, and that this connector has been added and configured for your application.\n\n#### ConnectionNotFoundError\n\nA valid connection could not be found associated to your `application_id`. Something _may_ have interrupted the authorization flow. You may need to start the connector authorization process again.\n\n#### ConnectionSettingsError\n\nThe connector has required settings that were not supplied. Verify `connection.settings` contains all required settings for the connector to be callable.\n\n#### ConnectorNotFoundError\n\nA request was made for an unknown connector. Verify your `service_id` is spelled correctly, and that this connector is enabled for your provided `unified_api`.\n\n#### OAuthRedirectUriError\n\nA request was made either in a connector authorization flow, or attempting to revoke connector access without a valid `redirect_uri`. This is the url the user should be returned to on completion of process.\n\n#### OAuthInvalidStateError\n\nThe state param is required and is used to ensure the outgoing authorization state has not been altered before the user is redirected back. It also contains required params needed to identify the connector being used. If this has been altered, the authorization will not succeed.\n\n#### OAuthCodeExchangeError\n\nWhen attempting to exchange the authorization code for an `access_token` during an OAuth flow, an error occurred. This may be temporary. You can reattempt authorization or contact our team to resolve the issue.\n\n#### OAuthConnectorError\n\nIt seems something went wrong on the connector side. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n#### MappingError\n\nThere was an error attempting to retrieve the mapping for a given attribute. We've been notified and are working to fix this issue.\n\n#### ConnectorMappingNotFoundError\n\nIt seems the implementation for this connector is incomplete. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n#### ConnectorResponseMappingNotFoundError\n\nWe were unable to retrieve the response mapping for this connector. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n#### ConnectorOperationMappingNotFoundError\n\nConnector mapping has not been implemented for the requested operation. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n#### ConnectorWorkflowMappingError\n\nThe composite api calls required for this operation have not been mapped entirely. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n#### ConnectorOperationUnsupportedError\n\nYou're attempting a call that is not supported by the connector. It's likely this operation is supported by another connector, but we're unable to implement for this one.\n\n#### PaginationNotSupportedError\n\nPagination is not yet supported for this connector, try removing limit and/or cursor from the query. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n## API Design\n\n### API Styles and data formats\n\n#### REST API\n\nThe API is organized around [REST](https://restfulapi.net/), providing simple and predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. JSON is returned by all API responses, including errors. In all API requests, you must set the content-type HTTP header to application/json. All API requests must be made over HTTPS. Calls made over HTTP will fail.\n\n##### Available HTTP methods\n\nThe Apideck API uses HTTP verbs to understand if you want to read (GET), delete (DELETE) or create (POST) an object. When your web application cannot do a POST or DELETE, we provide the ability to set the method through the query parameter \\_method.\n\n```\nPOST /messages\nGET /messages\nGET /messages/{messageId}\nPATCH /messages/{messageId}\nDELETE /messages/{messageId}\n```\n\nResponse bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. For some endpoints and use cases we divert from REST to provide a better developer experience.\n\n### Schema\n\nAll API requests and response bodies adhere to a common JSON format representing individual items, collections of items, links to related items and additional meta data.\n\n### Meta\n\nMeta data can be represented as a top level member named “meta”. Any information may be provided in the meta data. It’s most common use is to return the total number of records when requesting a collection of resources.\n\n### Request IDs\n\nEach API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.\n\n### Fixed field types\n\n#### Dates\n\nThe dates returned by the API are all represented in UTC (ISO8601 format).\n\nThis example\_`2019-11-14T00:55:31.820Z`\_is defined by the\_ISO 8601\_standard. The\_T\_in the middle separates the year-month-day portion from the hour-minute-second portion. The\_Z\_on the end means UTC, that is, an offset-from-UTC of zero hours-minutes-seconds. The\_Z\_is pronounced \"Zulu\" per military/aviation tradition.\n\nThe ISO 8601 standard is more modern. The formats are wisely designed to be easy to parse by machine as well as easy to read by humans across cultures.\n\n#### Currencies\n\nAll currency codes conform to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).\n\n## Support\n\nIf you have problems or need help with your case, you can always reach out to our Support.\n\n## Static IP\n\nSome of the APIs you want to use can require a static IP. Apideck's static IP feature allows you to use Apideck with a fixed IP avoiding the need for you to set up your own infrastructure. This feature is currently available to all Apideck customers.\nTo use this feature, the API Vendor will need to whitelist the associated static IP addresses.\nThe provided static IP addresses are fixed to their specified region and shared by all customers who use this feature.\n\n- EU Central 1: **18.197.244.247**, **18.156.9.3**, **3.65.139.215**\n- Other: upcoming\n\n More info about our data security can be found at [https://compliance.apideck.com/](https://compliance.apideck.com/)\n\n" contact: email: hello@apideck.com url: https://developers.apideck.com x-logo: url: https://developers.apideck.com/icon.png license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html x-apideck-api: sms x-apideck-sdk-support: true externalDocs: description: Apideck Developer Docs url: https://developers.apideck.com servers: - url: https://unify.apideck.com components: parameters: applicationId: name: x-apideck-app-id in: header required: true description: The ID of your Unify application schema: type: string minLength: 1 example: dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX x-speakeasy-name-override: appId serviceId: name: x-apideck-service-id in: header description: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. schema: type: string example: salesforce x-speakeasy-name-override: serviceId consumerId: name: x-apideck-consumer-id in: header required: true description: ID of the consumer which you want to get or push data from schema: type: string example: test-consumer x-speakeasy-name-override: consumerId raw: name: raw in: query description: Include raw response. Mostly used for debugging purposes schema: type: boolean default: false id: in: path name: id schema: type: string required: true description: ID of the record you are acting upon. limit: name: limit in: query description: Number of results to return. Minimum 1, Maximum 200, Default 20 schema: type: integer minimum: 1 maximum: 200 default: 20 cursor: name: cursor in: query description: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. schema: type: string nullable: true fields: name: fields in: query description: 'The ''fields'' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.' example: id,updated_at schema: type: string nullable: true responses: BadRequestResponse: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' CreateMessageResponse: description: Messages content: application/json: schema: $ref: '#/components/schemas/CreateMessageResponse' DeleteMessageResponse: description: Messages content: application/json: schema: $ref: '#/components/schemas/DeleteMessageResponse' GetMessageResponse: description: Messages content: application/json: schema: $ref: '#/components/schemas/GetMessageResponse' GetMessagesResponse: description: Messages content: application/json: schema: $ref: '#/components/schemas/GetMessagesResponse' NotFoundResponse: description: The specified resource was not found content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' NotImplementedResponse: description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/NotImplementedResponse' PaymentRequiredResponse: description: Payment Required content: application/json: schema: $ref: '#/components/schemas/PaymentRequiredResponse' TooManyRequestsResponse: description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsResponse' UnauthorizedResponse: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' UnexpectedErrorResponse: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/UnexpectedErrorResponse' UnprocessableResponse: description: Unprocessable content: application/json: schema: $ref: '#/components/schemas/UnprocessableResponse' UpdateMessageResponse: description: Messages content: application/json: schema: $ref: '#/components/schemas/UpdateMessageResponse' schemas: BadRequestResponse: type: object x-apideck-schema-id: BadRequest properties: status_code: type: number description: HTTP status code example: 400 error: type: string description: Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231) example: Bad Request type_name: type: string description: The type of error returned example: RequestValidationError message: type: string description: A human-readable message providing more details about the error. example: Invalid Params x-speakeasy-error-message: true detail: anyOf: - type: string example: Missing property foobar - type: object x-speakeasy-detail: true example: missing: - foobar: required description: Contains parameter or domain specific information related to the error and why it occurred. ref: type: string description: Link to documentation of error type example: https://developers.apideck.com/errors#requestvalidationerror downstream_errors: type: array description: Contains downstream errors returned from the connector. Only present when type_name is ConnectorExecutionError. items: type: object properties: message: type: string description: Error message from the downstream provider detail: type: string description: Additional error details code: type: string description: Error code from the downstream provider example: - message: Account code '100' has been archived or deleted detail: Each line item must reference a valid account code: VALIDATION_ERROR CreateMessageResponse: type: object x-apideck-schema-id: CreateMessageResponse required: - status_code - status - service - resource - operation - data properties: status_code: type: integer description: HTTP Response Status Code example: 200 status: type: string description: HTTP Response Status example: OK service: type: string description: Apideck ID of service provider example: twilio resource: type: string description: Unified API resource name example: Messages operation: type: string description: Operation performed example: add data: $ref: '#/components/schemas/UnifiedId' _raw: $ref: '#/components/schemas/Raw' Currency: type: string title: Currency description: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). example: USD x-apideck-enum-id: currencies x-apideck-enum-coverage-ignore: true enum: - UNKNOWN_CURRENCY - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYR - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STD - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRC - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - USS - UYI - UYU - UZS - VEF - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XTS - XXX - YER - ZAR - ZMK - ZMW - BTC - ETH x-enum-elements: - name: UNKNOWN_CURRENCY description: Unknown currency - name: AED description: United Arab Emirates dirham - name: AFN description: Afghan afghani - name: ALL description: Albanian lek - name: AMD description: Armenian dram - name: ANG description: Netherlands Antillean guilder - name: AOA description: Angolan kwanza - name: ARS description: Argentine peso - name: AUD description: Australian dollar - name: AWG description: Aruban florin - name: AZN description: Azerbaijani manat - name: BAM description: Bosnia and Herzegovina convertible mark - name: BBD description: Barbados dollar - name: BDT description: Bangladeshi taka - name: BGN description: Bulgarian lev - name: BHD description: Bahraini dinar - name: BIF description: Burundian franc - name: BMD description: Bermudian dollar - name: BND description: Brunei dollar - name: BOB description: Boliviano - name: BOV description: Bolivian Mvdol - name: BRL description: Brazilian real - name: BSD description: Bahamian dollar - name: BTN description: Bhutanese ngultrum - name: BWP description: Botswana pula - name: BYR description: Belarusian ruble - name: BZD description: Belize dollar - name: CAD description: Canadian dollar - name: CDF description: Congolese franc - name: CHE description: WIR Euro - name: CHF description: Swiss franc - name: CHW description: WIR Franc - name: CLF description: Unidad de Fomento - name: CLP description: Chilean peso - name: CNY description: Chinese yuan - name: COP description: Colombian peso - name: COU description: Unidad de Valor Real - name: CRC description: Costa Rican colon - name: CUC description: Cuban convertible peso - name: CUP description: Cuban peso - name: CVE description: Cape Verdean escudo - name: CZK description: Czech koruna - name: DJF description: Djiboutian franc - name: DKK description: Danish krone - name: DOP description: Dominican peso - name: DZD description: Algerian dinar - name: EGP description: Egyptian pound - name: ERN description: Eritrean nakfa - name: ETB description: Ethiopian birr - name: EUR description: Euro - name: FJD description: Fiji dollar - name: FKP description: Falkland Islands pound - name: GBP description: Pound sterling - name: GEL description: Georgian lari - name: GHS description: Ghanaian cedi - name: GIP description: Gibraltar pound - name: GMD description: Gambian dalasi - name: GNF description: Guinean franc - name: GTQ description: Guatemalan quetzal - name: GYD description: Guyanese dollar - name: HKD description: Hong Kong dollar - name: HNL description: Honduran lempira - name: HRK description: Croatian kuna - name: HTG description: Haitian gourde - name: HUF description: Hungarian forint - name: IDR description: Indonesian rupiah - name: ILS description: Israeli new shekel - name: INR description: Indian rupee - name: IQD description: Iraqi dinar - name: IRR description: Iranian rial - name: ISK description: Icelandic króna - name: JMD description: Jamaican dollar - name: JOD description: Jordanian dinar - name: JPY description: Japanese yen - name: KES description: Kenyan shilling - name: KGS description: Kyrgyzstani som - name: KHR description: Cambodian riel - name: KMF description: Comoro franc - name: KPW description: North Korean won - name: KRW description: South Korean won - name: KWD description: Kuwaiti dinar - name: KYD description: Cayman Islands dollar - name: KZT description: Kazakhstani tenge - name: LAK description: Lao kip - name: LBP description: Lebanese pound - name: LKR description: Sri Lankan rupee - name: LRD description: Liberian dollar - name: LSL description: Lesotho loti - name: LTL description: Lithuanian litas - name: LVL description: Latvian lats - name: LYD description: Libyan dinar - name: MAD description: Moroccan dirham - name: MDL description: Moldovan leu - name: MGA description: Malagasy ariary - name: MKD description: Macedonian denar - name: MMK description: Myanmar kyat - name: MNT description: Mongolian tögrög - name: MOP description: Macanese pataca - name: MRO description: Mauritanian ouguiya - name: MUR description: Mauritian rupee - name: MVR description: Maldivian rufiyaa - name: MWK description: Malawian kwacha - name: MXN description: Mexican peso - name: MXV description: Mexican Unidad de Inversion - name: MYR description: Malaysian ringgit - name: MZN description: Mozambican metical - name: NAD description: Namibian dollar - name: NGN description: Nigerian naira - name: NIO description: Nicaraguan córdoba - name: NOK description: Norwegian krone - name: NPR description: Nepalese rupee - name: NZD description: New Zealand dollar - name: OMR description: Omani rial - name: PAB description: Panamanian balboa - name: PEN description: Peruvian sol - name: PGK description: Papua New Guinean kina - name: PHP description: Philippine peso - name: PKR description: Pakistani rupee - name: PLN description: Polish złoty - name: PYG description: Paraguayan guaraní - name: QAR description: Qatari riyal - name: RON description: Romanian leu - name: RSD description: Serbian dinar - name: RUB description: Russian ruble - name: RWF description: Rwandan franc - name: SAR description: Saudi riyal - name: SBD description: Solomon Islands dollar - name: SCR description: Seychelles rupee - name: SDG description: Sudanese pound - name: SEK description: Swedish krona - name: SGD description: Singapore dollar - name: SHP description: Saint Helena pound - name: SLL description: Sierra Leonean leone - name: SOS description: Somali shilling - name: SRD description: Surinamese dollar - name: SSP description: South Sudanese pound - name: STD description: São Tomé and Príncipe dobra - name: SVC description: Salvadoran colón - name: SYP description: Syrian pound - name: SZL description: Swazi lilangeni - name: THB description: Thai baht - name: TJS description: Tajikstani somoni - name: TMT description: Turkmenistan manat - name: TND description: Tunisian dinar - name: TOP description: Tongan pa'anga - name: TRY description: Turkish lira - name: TTD description: Trinidad and Tobago dollar - name: TWD description: New Taiwan dollar - name: TZS description: Tanzanian shilling - name: UAH description: Ukrainian hryvnia - name: UGX description: Ugandan shilling - name: USD description: United States dollar - name: USN description: United States dollar (next day) - name: USS description: United States dollar (same day) - name: UYI description: Uruguay Peso en Unidedades Indexadas - name: UYU description: Uruguyan peso - name: UZS description: Uzbekistan som - name: VEF description: Venezuelan bolívar soberano - name: VND description: Vietnamese đồng - name: VUV description: Vanuatu vatu - name: WST description: Samoan tala - name: XAF description: CFA franc BEAC - name: XAG description: Silver - name: XAU description: Gold - name: XBA description: European Composite Unit - name: XBB description: European Monetary Unit - name: XBC description: European Unit of Account 9 - name: XBD description: European Unit of Account 17 - name: XCD description: East Caribbean dollar - name: XDR description: Special drawing rights (International Monetary Fund) - name: XOF description: CFA franc BCEAO - name: XPD description: Palladium - name: XPF description: CFP franc - name: XPT description: Platinum - name: XTS description: Code reserved for testing - name: XXX description: No currency - name: YER description: Yemeni rial - name: ZAR description: South African rand - name: ZMK description: Zambian kwacha - name: ZMW description: Zambian kwacha - name: BTC description: Bitcoin - name: ETH description: Ether nullable: true CustomField: type: object x-apideck-schema-id: CustomField additionalProperties: false anyOf: - required: - id - required: - name x-apideck-strict-any-of: - required: - id - required: - name x-apideck-weights: id: critical value: critical name: medium description: edge-case properties: id: title: ID description: Unique identifier for the custom field. type: string example: '2389328923893298' nullable: true name: title: Name type: string description: Name of the custom field. example: employee_level nullable: true description: title: Description type: string description: More information about the custom field example: Employee Level nullable: true value: anyOf: - type: string example: Uses Salesforce and Marketo nullable: true - type: number example: 10 nullable: true - type: boolean example: true nullable: true - type: object example: foo: bar nullable: true additionalProperties: true - type: array items: anyOf: - type: string example: Uses Salesforce and Marketo nullable: true - type: number example: 10 nullable: true - type: boolean example: true nullable: true - type: object example: foo: bar nullable: true additionalProperties: true CustomMappings: type: object x-apideck-schema-id: CustomMappings description: When custom mappings are configured on the resource, the result is included here. nullable: true readOnly: true additionalProperties: true DeleteMessageResponse: type: object x-apideck-schema-id: DeleteMessageResponse required: - status_code - status - service - resource - operation - data properties: status_code: type: integer description: HTTP Response Status Code example: 200 status: type: string description: HTTP Response Status example: OK service: type: string description: Apideck ID of service provider example: twilio resource: type: string description: Unified API resource name example: Messages operation: type: string description: Operation performed example: delete data: $ref: '#/components/schemas/UnifiedId' _raw: $ref: '#/components/schemas/Raw' Email: type: object x-apideck-schema-id: Email required: - email additionalProperties: false x-apideck-weights: email: critical type: critical id: edge-case properties: id: type: string example: '123' description: Unique identifier for the email address nullable: true email: type: string format: email description: Email address example: elon@musk.com minLength: 1 nullable: true type: type: string description: Email type x-apideck-enum-id: emails.type enum: - primary - secondary - work - personal - billing - other example: primary nullable: true GetMessageResponse: type: object x-apideck-schema-id: GetMessageResponse required: - status_code - status - service - resource - operation - data properties: status_code: type: integer description: HTTP Response Status Code example: 200 status: type: string description: HTTP Response Status example: OK service: type: string description: Apideck ID of service provider example: twilio resource: type: string description: Unified API resource name example: Messages operation: type: string description: Operation performed example: one data: $ref: '#/components/schemas/Message' _raw: $ref: '#/components/schemas/Raw' GetMessagesResponse: type: object x-apideck-schema-id: GetMessagesResponse required: - status_code - status - service - resource - operation - data properties: status_code: type: integer description: HTTP Response Status Code example: 200 status: type: string description: HTTP Response Status example: OK service: type: string description: Apideck ID of service provider example: twilio resource: type: string description: Unified API resource name example: Messages operation: type: string description: Operation performed example: all data: type: array items: $ref: '#/components/schemas/Message' _raw: $ref: '#/components/schemas/Raw' meta: $ref: '#/components/schemas/Meta' links: $ref: '#/components/schemas/Links' Links: type: object x-apideck-schema-id: Links description: Links to navigate to previous or next pages through the API properties: previous: type: string description: Link to navigate to the previous page through the API example: https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D nullable: true current: type: string description: Link to navigate to the current page through the API example: https://unify.apideck.com/crm/companies next: type: string description: Link to navigate to the previous page through the API example: https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM nullable: true Message: type: object x-apideck-schema-id: Message additionalProperties: false x-apideck-weights: id: critical from: critical to: critical subject: medium body: critical type: high status: high price: edge-case error: edge-case messaging_service_id: edge-case number_of_units: low number_of_media_files: edge-case webhook_url: low required: - from - to - body properties: id: type: string title: ID description: A unique identifier for an object. example: '12345' readOnly: true from: title: From description: The phone number that initiated the message. type: string example: '+15017122661' to: title: Message Body description: The phone number that received the message. type: string example: '+15017122662' subject: title: Message Subject type: string example: Picture body: title: Message Body description: The message text. type: string maxLength: 1600 example: Hi! How are you doing? type: title: Message type description: Set to sms for SMS messages and mms for MMS messages. type: string x-apideck-enum-id: messages.type enum: - sms - mms example: sms number_of_units: readOnly: true title: Number of units description: The number of units that make up the complete message. Messages can be split up due to the constraints of the message size. type: integer example: 1 number_of_media_files: readOnly: true title: Number of media files description: The number of media files associated with the message. type: integer example: 1 direction: readOnly: true title: Direction description: The direction of the message. type: string x-apideck-enum-id: messages.direction enum: - inbound - outbound-api - outbound-call - outbound-reply - unknown example: outbound-api status: title: Status description: Status of the delivery of the message. type: string readOnly: true x-apideck-enum-id: messages.status enum: - accepted - scheduled - canceled - queued - sending - sent - failed - delivered - undelivered - receiving - received - read example: sent scheduled_at: type: string format: date-time description: The scheduled date and time of the message. example: '2020-09-30T07:43:32.000Z' sent_at: type: string format: date-time description: The date and time that the message was sent example: '2020-09-30T07:43:32.000Z' readOnly: true webhook_url: type: string title: Webhook URL description: Define a webhook to receive delivery notifications. example: https://unify.apideck.com/webhook/webhooks/eyz329dkffdl4949/x/sms reference: title: Reference description: A client reference. type: string example: CUST001 price: title: Price description: Price of the message. readOnly: true type: object example: per_unit: '0.01' total_amount: '0.01' currency: USD properties: per_unit: readOnly: true title: Price per unit description: '' type: string example: '0.01' total_amount: readOnly: true title: Price Amount description: '' type: string example: '0.01' currency: $ref: '#/components/schemas/Currency' error: title: Error description: The error returned if your message status is failed or undelivered. readOnly: true type: object example: code: X1 message: Something went wrong properties: code: readOnly: true title: Error Code description: The error_code provides more information about the failure. If the message was successful, this value is null type: string example: X1 message: readOnly: true title: Error Message type: string example: Something went wrong messaging_service_id: title: Messaging Service ID description: The ID of the Messaging Service used with the message. In case of Plivo this links to the Powerpack ID. type: string example: '123456' custom_mappings: $ref: '#/components/schemas/CustomMappings' updated_by: type: string title: Updated by description: The user who last updated the object. example: '12345' readOnly: true nullable: true created_by: type: string title: Created by description: The user who created the object. example: '12345' readOnly: true nullable: true updated_at: type: string title: Updated at (timestamp) description: The date and time when the object was last updated. format: date-time example: '2020-09-30T07:43:32.000Z' readOnly: true nullable: true created_at: type: string title: Created at (timestamp) description: The date and time when the object was created. format: date-time example: '2020-09-30T07:43:32.000Z' readOnly: true nullable: true pass_through: $ref: '#/components/schemas/PassThroughBody' Meta: type: object x-apideck-schema-id: Meta description: Response metadata properties: items_on_page: type: integer description: Number of items returned in the data property of the response example: 50 cursors: type: object description: Cursors to navigate to previous or next pages through the API properties: previous: type: string description: Cursor to navigate to the previous page of results through the API example: em9oby1jcm06OnBhZ2U6OjE= nullable: true current: type: string description: Cursor to navigate to the current page of results through the API example: em9oby1jcm06OnBhZ2U6OjI= nullable: true next: type: string description: Cursor to navigate to the next page of results through the API example: em9oby1jcm06OnBhZ2U6OjM= nullable: true NotFoundResponse: type: object x-apideck-schema-id: NotFound properties: status_code: type: number description: HTTP status code example: 404 error: type: string description: Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231) example: Not Found type_name: type: string description: The type of error returned example: EntityNotFoundError message: type: string description: A human-readable message providing more details about the error. example: Unknown Widget x-speakeasy-error-message: true detail: anyOf: - type: string example: "Could not find widget with id: '123'" - type: object x-speakeasy-detail: true example: not_found: entity: widget id: '123' description: Contains parameter or domain specific information related to the error and why it occurred. ref: type: string description: Link to documentation of error type example: https://developers.apideck.com/errors#entitynotfounderror NotImplementedResponse: type: object x-apideck-schema-id: NotImplemented properties: status_code: type: number description: HTTP status code example: 501 error: type: string description: Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231) example: Not Implemented type_name: type: string description: The type of error returned example: MappingError message: type: string description: A human-readable message providing more details about the error. example: Unmapped Attribute x-speakeasy-error-message: true detail: anyOf: - type: string example: Failed to retrieve Widget tokenUrl from 'components.securitySchemes.OAuth2.flows' - type: object x-speakeasy-detail: true description: Contains parameter or domain specific information related to the error and why it occurred. ref: type: string description: Link to documentation of error type example: https://developers.apideck.com/errors#mappingerror PassThroughBody: type: array description: The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. items: type: object properties: service_id: type: string description: Identifier for the service to which this pass_through should be applied. operation_id: type: string description: Optional identifier for a workflow operation to which this pass_through should be applied. This is useful for Unify calls that are making more than one downstream request. extend_object: type: object additionalProperties: true description: Simple object allowing any properties for direct extension. extend_paths: type: array description: Array of objects for structured data modifications via paths. items: type: object properties: path: type: string description: JSONPath string specifying where to apply the value. example: $.nested.property value: description: The value to set at the specified path, can be any type. example: &ref_0 TaxClassificationRef: value: EUC-99990201-V1-00020000 required: - path - value additionalProperties: false required: - service_id additionalProperties: false writeOnly: true PassThroughQuery: type: object additionalProperties: true properties: example_downstream_property: type: string description: All passthrough query parameters are passed along to the connector as is (?pass_through[search]=leads becomes ?search=leads) example: search: San Francisco PaymentRequiredResponse: type: object x-apideck-schema-id: PaymentRequired properties: status_code: type: number description: HTTP status code example: 402 error: type: string description: Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231) example: Payment Required type_name: type: string description: The type of error returned example: RequestLimitError message: type: string description: A human-readable message providing more details about the error. example: Request Limit Reached x-speakeasy-error-message: true detail: type: string description: Contains parameter or domain specific information related to the error and why it occurred. example: You have reached your limit of 2000 ref: type: string description: Link to documentation of error type example: https://developers.apideck.com/errors#requestlimiterror Tags: type: array x-apideck-schema-id: Tags items: type: string example: - New nullable: true TooManyRequestsResponse: type: object x-apideck-schema-id: TooManyRequests properties: status_code: type: number description: HTTP status code example: 429 error: type: string description: Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 6585) example: Too Many Requests type_name: type: string description: The type of error returned example: ConnectorRateLimitError message: type: string description: A human-readable message providing more details about the error. example: Connector Rate Limit Error x-speakeasy-error-message: true detail: type: object properties: context: type: string error: type: object x-speakeasy-detail: true ref: type: string description: Link to documentation of error type example: https://developers.apideck.com/errors#connectorratelimiterror UnauthorizedResponse: type: object x-apideck-schema-id: Unauthorized properties: status_code: type: number description: HTTP status code example: 401 error: type: string description: Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231) example: Unauthorized type_name: type: string description: The type of error returned example: UnauthorizedError message: type: string description: A human-readable message providing more details about the error. example: Unauthorized Request x-speakeasy-error-message: true detail: anyOf: - type: string example: Missing authentication - type: object x-speakeasy-detail: true properties: type: type: string description: Error type identifier example: refresh_token_connector_error message: type: string description: Detailed error message example: Token refresh failed debug: type: object description: Debug information including request/response details and OAuth timing metadata properties: request: type: object description: HTTP request details response: type: object description: HTTP response details message: type: string description: Error message from downstream provider or network layer code: type: string description: Error code (e.g., ETIMEDOUT, ECONNREFUSED) credentials_expire_at_ms: type: number description: Unix timestamp (milliseconds) when credentials will be deleted if not refreshed. Only present for non-recoverable errors (401, 400). Credentials are preserved indefinitely for recoverable/network errors. example: 1620172800000 retry_after_ms: type: number description: Unix timestamp (milliseconds) when token refresh retry is allowed after cooldown period expires. example: 1620000030000 cooldown_remaining_ms: type: number description: Milliseconds remaining in cooldown period before retry is allowed. example: 30000 example: type: refresh_token_connector_error message: Token refresh failed with 401 error debug: response: statusCode: 401 data: error: invalid_grant credentials_expire_at_ms: 1620172800000 retry_after_ms: 1620000030000 cooldown_remaining_ms: 30000 description: Contains parameter or domain specific information related to the error and why it occurred. ref: type: string description: Link to documentation of error type example: https://developers.apideck.com/errors#unauthorizederror UnexpectedErrorResponse: type: object x-apideck-schema-id: Error properties: status_code: type: number description: HTTP status code example: 400 error: type: string description: Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231) example: Bad Request type_name: type: string description: The type of error returned example: RequestHeadersValidationError message: type: string description: A human-readable message providing more details about the error. example: Invalid Params x-speakeasy-error-message: true detail: anyOf: - type: string example: 'Missing Header: x-apideck-consumer-id' - type: object x-speakeasy-detail: true example: missing: - x-apideck-consumer-id: required description: Contains parameter or domain specific information related to the error and why it occurred. ref: type: string description: Link to documentation of error type example: https://developers.apideck.com/errors#unauthorizederror UnifiedId: title: UnifiedId type: object x-apideck-schema-id: Id description: A object containing a unique identifier for the resource that was created, updated, or deleted. required: - id properties: id: title: Id description: The unique identifier of the resource type: string readOnly: true example: '12345' UnprocessableResponse: type: object x-apideck-schema-id: Unprocessable properties: status_code: type: number description: HTTP status code example: 422 error: type: string description: Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231) example: Unprocessable Entity type_name: type: string description: The type of error returned example: InvalidStateError message: type: string description: A human-readable message providing more details about the error. example: Invalid State x-speakeasy-error-message: true detail: anyOf: - type: string example: Unprocessable request, please verify your request headers and body. - type: object x-speakeasy-detail: true example: error: Unprocessable message: Unprocessable request, please verify your request headers and body. description: Contains parameter or domain specific information related to the error and why it occurred. ref: type: string description: Link to documentation of error type example: https://developers.apideck.com/errors#invalidstateerror UpdateMessageResponse: type: object x-apideck-schema-id: UpdateMessageResponse required: - status_code - status - service - resource - operation - data properties: status_code: type: integer description: HTTP Response Status Code example: 200 status: type: string description: HTTP Response Status example: OK service: type: string description: Apideck ID of service provider example: twilio resource: type: string description: Unified API resource name example: Messages operation: type: string description: Operation performed example: update data: $ref: '#/components/schemas/UnifiedId' _raw: $ref: '#/components/schemas/Raw' Raw: title: raw type: object x-apideck-schema-id: Raw description: Raw response from the integration when raw=true query param is provided nullable: true additionalProperties: true securitySchemes: apiKey: type: apiKey in: header name: Authorization description: | To access our API, you need to sign up and obtain your unique API key. Each Unify application is assigned a single API key. You can locate your API key in the Configuration Settings section of your Apideck application. Additionally, your application’s application_id is available on the same page. Authenticate your API requests by including your test or live secret API key in the request header. - Bearer authorization header: `Authorization: Bearer "YOUR_API_KEY_HERE"` - Application id header: `x-apideck-app-id: "YOUR_APP_ID_HERE"` You should use the public keys on the SDKs and the secret keys to authenticate API requests. **Do not share or include your secret API keys on client side code.** Your API keys carry significant privileges. Please ensure to keep them 100% secure and be sure to not share your secret API keys in areas that are publicly accessible like GitHub. Learn how to set the Authorization header inside Postman https://learning.postman.com/docs/postman/sending-api-requests/authorization/#api-key Go to Unify to grab your API KEY https://app.apideck.com/unify/api-keys security: - apiKey: [] tags: - name: Messages description: A Message represents an SMS communication, including sender, recipient, body text, delivery status, and timestamp. x-apideck-resource-id: messages x-apideck-model: $ref: '#/components/schemas/Message' paths: /sms/messages: get: tags: - Messages operationId: messagesAll summary: List Messages description: List Messages parameters: - $ref: '#/components/parameters/raw' - $ref: '#/components/parameters/consumerId' - $ref: '#/components/parameters/applicationId' - $ref: '#/components/parameters/serviceId' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/fields' security: - apiKey: [] responses: '200': $ref: '#/components/responses/GetMessagesResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '402': $ref: '#/components/responses/PaymentRequiredResponse' '404': $ref: '#/components/responses/NotFoundResponse' '422': $ref: '#/components/responses/UnprocessableResponse' default: $ref: '#/components/responses/UnexpectedErrorResponse' x-apideck-api: sms x-codeSamples: - lang: TypeScript label: Node source: {} post: tags: - Messages operationId: messagesAdd summary: Create Message description: Create Message parameters: - $ref: '#/components/parameters/raw' - $ref: '#/components/parameters/consumerId' - $ref: '#/components/parameters/applicationId' - $ref: '#/components/parameters/serviceId' security: - apiKey: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Message' responses: '201': $ref: '#/components/responses/CreateMessageResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '402': $ref: '#/components/responses/PaymentRequiredResponse' '404': $ref: '#/components/responses/NotFoundResponse' '422': $ref: '#/components/responses/UnprocessableResponse' default: $ref: '#/components/responses/UnexpectedErrorResponse' x-apideck-api: sms x-codeSamples: - lang: TypeScript label: Node source: message: from: '+15017122661' to: '+15017122662' subject: Picture body: Hi! How are you doing? type: sms scheduled_at: '2020-09-30T07:43:32.000Z' webhook_url: https://unify.apideck.com/webhook/webhooks/eyz329dkffdl4949/x/sms reference: CUST001 messaging_service_id: '123456' pass_through: - service_id: string operation_id: string extend_object: {} extend_paths: - path: $.nested.property value: *ref_0 /sms/messages/{id}: get: tags: - Messages operationId: messagesOne summary: Get Message description: Get Message parameters: - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/consumerId' - $ref: '#/components/parameters/applicationId' - $ref: '#/components/parameters/serviceId' - $ref: '#/components/parameters/raw' - $ref: '#/components/parameters/fields' security: - apiKey: [] responses: '200': $ref: '#/components/responses/GetMessageResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '402': $ref: '#/components/responses/PaymentRequiredResponse' '404': $ref: '#/components/responses/NotFoundResponse' '422': $ref: '#/components/responses/UnprocessableResponse' default: $ref: '#/components/responses/UnexpectedErrorResponse' x-apideck-api: sms x-codeSamples: - lang: TypeScript label: Node source: id: id_example patch: tags: - Messages operationId: messagesUpdate summary: Update Message description: Update Message parameters: - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/consumerId' - $ref: '#/components/parameters/applicationId' - $ref: '#/components/parameters/serviceId' - $ref: '#/components/parameters/raw' security: - apiKey: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Message' responses: '200': $ref: '#/components/responses/UpdateMessageResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '402': $ref: '#/components/responses/PaymentRequiredResponse' '404': $ref: '#/components/responses/NotFoundResponse' '422': $ref: '#/components/responses/UnprocessableResponse' default: $ref: '#/components/responses/UnexpectedErrorResponse' x-apideck-api: sms x-codeSamples: - lang: TypeScript label: Node source: id: id_example message: from: '+15017122661' to: '+15017122662' subject: Picture body: Hi! How are you doing? type: sms scheduled_at: '2020-09-30T07:43:32.000Z' webhook_url: https://unify.apideck.com/webhook/webhooks/eyz329dkffdl4949/x/sms reference: CUST001 messaging_service_id: '123456' pass_through: - service_id: string operation_id: string extend_object: {} extend_paths: - path: $.nested.property value: *ref_0 delete: tags: - Messages operationId: messagesDelete summary: Delete Message description: Delete Message parameters: - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/consumerId' - $ref: '#/components/parameters/applicationId' - $ref: '#/components/parameters/serviceId' - $ref: '#/components/parameters/raw' security: - apiKey: [] responses: '200': $ref: '#/components/responses/DeleteMessageResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '402': $ref: '#/components/responses/PaymentRequiredResponse' '404': $ref: '#/components/responses/NotFoundResponse' '422': $ref: '#/components/responses/UnprocessableResponse' default: $ref: '#/components/responses/UnexpectedErrorResponse' x-apideck-api: sms x-codeSamples: - lang: TypeScript label: Node source: id: id_example