SIsinch
Cover pages

Add cover page

Changed on

Add a cover page to your service

post/v3/projects/{projectId}/services/{id}/coverPages

Request

  • Base URL
    https://fax.api.sinch.com
  • URL
    https://fax.api.sinch.com/v3/projects/{projectId}/services/{id}/coverPages
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://auth.sinch.com/oauth2/token

Request body

idstring ulid

ID of the cover page

namestring required

The friendly name of the cover page.

projectIdstring

The Id of the project associated with the call.

serviceIdstring

ID of the fax service used.

createdTimestring date-time

The date and time the cover page was created.

updatedTimestring date-time

The date and time the cover page was updated.

createdAtstring date-time

The timestamp on which the cover page was created.

updatedAtstring date-time

The timestamp on which the cover page was updated.

Example request

{
  "name": "Acme Company cover page",
  "projectId": "ae00f005-e392-44dc-b3f5-a657a2684dg3",
  "serviceId": "01GVRB50KEQFFE1SGMPFRNBG6J",
  "createdTime": "2025-10-24 18:56:42+00:00",
  "updatedTime": "2025-10-24 19:11:50+00:00",
  "createdAt": "2025-10-24 18:56:42+00:00",
  "updatedAt": "2025-10-24 19:11:50+00:00"
}

Response

The added coverpage, or an Error

idstring ulid

ID of the cover page

namestring required

The friendly name of the cover page.

projectIdstring

The Id of the project associated with the call.

serviceIdstring

ID of the fax service used.

createdTimestring date-time

The date and time the cover page was created.

updatedTimestring date-time

The date and time the cover page was updated.

createdAtstring date-time

The timestamp on which the cover page was created.

updatedAtstring date-time

The timestamp on which the cover page was updated.

Example response

{
  "name": "Acme Company cover page",
  "projectId": "ae00f005-e392-44dc-b3f5-a657a2684dg3",
  "serviceId": "01GVRB50KEQFFE1SGMPFRNBG6J",
  "createdTime": "2025-10-24 18:56:42+00:00",
  "updatedTime": "2025-10-24 19:11:50+00:00",
  "createdAt": "2025-10-24 18:56:42+00:00",
  "updatedAt": "2025-10-24 19:11:50+00:00"
}

Changes

  • d3054d7412d5Revision changes
    • breaking

      added subschema #2 to the request body allOf list

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status

  • 7f5e54fa9f05Revision changes
    • info

      endpoint added