New API Reference
API Reference/New

New

For authentication instructions, see API overview.

Endpoints

get/api/v2/new_templates
post/api/v2/new_templates
get/api/v2/new_templates/:id
put/api/v2/new_templates/:id
patch/api/v2/new_templates/:id
delete/api/v2/new_templates/deleted/:id
get

List all new templates

Returns a list of new templates. The new templates are returned in sorted order, with the most recent appearing first.

Query parameters

  • limitinteger

    The number of records to return

  • pageinteger

    The page number

  • orderstring

    The order of the records

  • sortBystring

    The sort of the records

  • fieldsstring

    The filter of the records

  • pstring

    policyFilters

  • qstring

    search query

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/new_templates

Response

No response schema
post

Create new templates

Create new templates. You need to pass through any required fields, and you can optionally pass through other fields.

Request body

  • typestring
  • descriptionstring
  • subjectstring
  • bodystring
  • categoriesarray
  • modulesarray
  • usersarray
  • publicboolean

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X POST -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/new_templates \
	-d 'type="email"' \
	-d 'description="description1"' \
	-d 'subject="Hello, Monem"' \
	-d 'body="Hello, Monem how are you?"' \
	-d 'categories="array"' \
	-d 'modules="array"' \
	-d 'users="array"' \
	-d 'public=true'

Response

No response schema
get

Retrieve new templates

Returns a single new template, which you can request by passing through an id in the url.

Path parameters

  • idstring

    ID of the new template

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/new_templates/:id

Response

No response schema
put

Update new templates

Path parameters

  • idstring

    ID of the new template

Request body

  • typestring
  • descriptionstring
  • subjectstring
  • bodystring
  • categoriesarray
  • modulesarray
  • usersarray
  • publicboolean

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X PUT \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/new_templates/:id \
	-d 'type="email"' \
	-d 'description="description1"' \
	-d 'subject="Hello, Monem"' \
	-d 'body="Hello, Monem how are you?"' \
	-d 'categories="array"' \
	-d 'modules="array"' \
	-d 'users="array"' \
	-d 'public=true'

Response

No response schema
patch

Update new templates soft

Update new templates soft by setting the values of the parameters passed. Any parameters not set will be unchanged.

Path parameters

  • idstring

    ID of the new template

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/new_templates/:id

Response

No response schema
delete

Delete new templates

Path parameters

  • idstring

    ID of the new template

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X DELETE \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/new_templates/deleted/:id

Response

No response schema