# Sinch Cover pages API

**Canonical:** https://apis.io/apis/sinch/sinch-cover-pages-api/  
**Provider:** Sinch — https://apis.io/providers/sinch/  
**Base URL:** https://us.conversation.api.sinch.com  
**Documentation:** https://developers.sinch.com/docs/conversation/api-reference/conversation

Sinch Cover pages API is one of 101 APIs that [Sinch](https://apis.io/providers/sinch/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification. This API exposes 73 JSON Schema definitions. Tagged areas include Cover pages. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, an AsyncAPI specification, and 73 JSON Schemas.

You can add cover pages to Sinch Fax either via the API or the [Build dashboard](https://dashboard.sinch.com). A Fax service can have 0 or more cover pages configured. ### When cover pages are added #### Via dashboard In the **Send Fax** tab you can select the option to ***select a cover page from a drop down***. When one is selected it will use that cover page on all outbound faxes. **Note:** If you are using Fax to Email, this is currently the only way to add a cover page to your faxes. #### Via API When sending a fax using the API, you can specify `coverPageId` and supply your own cover page data. ### How to create a cover page Create a PDF that fits your brand. It should have all the standard static content you need to stay compliant. Insert tags that will be replaced at run time by us for dynamic content. #### Automatic fields If we find the tags described in the table below, we will replace these tokens with fax metadata. |Tag | Content | Example |Description | | ---- | ----- | ----- | ----- | |{{from}}| string | +15557897890 | Your Sinch number that you used to send the fax. | |{{to}}| string | +15551231234 | The number to which you are sending the fax. | |{{date}}| date | 2/4/2025 | The date when the fax was sent. | |{{pageCount}}| number | 52 | The total number of pages to be transmitted. | ### Specifying your own dynamic fields in API calls When sending faxes via API you can add any tags you like with `{{}}`` syntax and set those in your app calls for cover page data. Example: If you would like to add the recipient's name and your own message on the cover page: ```json /// in your template pdf Fax to : {{to_name}} {{my_custom_message}} { ///other fax fields removed for clarity coverPageData: { "to_name": "Dr. John Smith", "my_custom_message": "I know you are busy please take on this patient" } } ```

## Operations (4)

| Method | Path | Summary |
|---|---|---|
| POST | `/v3/projects/{projectId}/services/{id}/coverPages` | Add cover page |
| GET | `/v3/projects/{projectId}/services/{id}/coverPages` | List cover pages |
| DELETE | `/v3/projects/{projectId}/services/{id}/coverPages/{coverPageId}` | Delete a cover page |
| GET | `/v3/projects/{projectId}/services/{id}/coverPages/{coverPageId}` | Get a cover page |

## Machine-readable artifacts (107)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/openapi/sinch-cover-pages-api-openapi.yml
- **Documentation** — https://developers.sinch.com/docs/conversation
- **APIReference** — https://developers.sinch.com/docs/conversation/api-reference/template
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-v2-template-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-v2-list-translations-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-v2-list-templates-response-schema.json
- **Documentation** — https://developers.sinch.com/docs/est
- **APIReference** — https://developers.sinch.com/docs/est/api-reference/est
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-call-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-sip-trunk-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-sip-endpoint-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-ip-range-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-access-control-list-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-number-schema.json
- **Documentation** — https://developers.sinch.com/docs/fax
- **APIReference** — https://developers.sinch.com/docs/fax/api-reference/fax
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-fax-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-service-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-template-by-name-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-update-template-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-service-phone-number-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-cover-page-schema.json
- **Documentation** — https://developers.sinch.com/docs/number-lookup-api-v2
- **APIReference** — https://developers.sinch.com/docs/number-lookup-api-v2/api-reference/number-lookup-v2
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-number-lookup-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-number-lookup-request-schema.json
- **Documentation** — https://developers.sinch.com/docs/numbers
- **APIReference** — https://developers.sinch.com/docs/numbers/api-reference/imported-hosting
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-hosting-order-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-qualified-number-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-text-enable-numbers-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-hosting-order-number-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-imported-number-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-list-imported-numbers-response-schema.json
- **APIReference** — https://developers.sinch.com/docs/numbers/api-reference/numbers
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-active-number-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-rent-any-number-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-validate-address-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-number-order-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-create-number-order-request-schema.json
- …and 67 more, listed in full on the page.

## Other Sinch APIs (12)

- [Sinch Conversation API](https://apis.io/apis/sinch/sinch-conversation-api/)
- [Sinch Voice API](https://apis.io/apis/sinch/sinch-voice-api/)
- [Sinch Brands API](https://apis.io/apis/sinch/sinch-brands-api/)
- [Sinch MMS API](https://apis.io/apis/sinch/sinch-mms-api/)
- [Sinch Batches API](https://apis.io/apis/sinch/sinch-batches-api/)
- [Sinch Delivery Reports API](https://apis.io/apis/sinch/sinch-delivery-reports-api/)
- [Sinch Inbounds API](https://apis.io/apis/sinch/sinch-inbounds-api/)
- [Sinch Groups API](https://apis.io/apis/sinch/sinch-groups-api/)
- [Sinch 10DLC Brand Registration API](https://apis.io/apis/sinch/sinch-10dlc-brand-registration-api/)
- [Sinch 10DLC Campaign Registration API](https://apis.io/apis/sinch/sinch-10dlc-campaign-registration-api/)
- [Sinch Access Control List API](https://apis.io/apis/sinch/sinch-access-control-list-api/)
- [Sinch Access Control Lists API](https://apis.io/apis/sinch/sinch-access-control-lists-api/)

## Tags

Cover pages

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/sinch/sinch-cover-pages-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/sinch/.