Resources

Using Whispir’s API, you can submit data payloads to be stored by Whispir and used in various API calls.

Using the /resources endpoint, you can upload, retrieve, update and delete resources. These resources can be used as part of Whispir’s bulk (dynamic) messages, or used for importing contacts.

Method description

GET

/resources

  • Provides a list of all the currently saved resources in the company (URIs), sorted by most recently updated.

/resources/{:id}

  • Retrieves the representation of the requested resource. (This doesn't allow you to download the resource, only the representation.)

/workspaces/(id)/resources

  • Provides a list of all the currently saved resources in the specified workspace(URIs), sorted by most recently updated.

/workspaces/(id)/resources/(id)

  • Retrieves the representation of the requested resource. (This doesn't allow you to download the resource, only the representation.)

POST

/resources

  • Creates a new resource for use in the API.

/resources/{:id}

  • METHOD not supported.

/workspaces/(id)/resources

  • Create a new resource for use in the API under the particular workspace.

/workspaces/(id)/resources/{:id}

  • METHOD not supported.

PUT

/resources

  • METHOD not supported.

/resources/{:id}

  • Update the specified resource with the one supplied in the request.

/workspaces/(id)/resources

  • METHOD not supported

/workspaces/(id)/resources/{:id}

  • Update the specified resource with the one supplied in the request under the particular workspace

DELETE

/resources

  • METHOD not supported

/resources/{:id}

  • Delete the specified resource from the Whispir platform.

/workspaces/(id)/resources

  • METHOD not supported.

/workspaces/(id)/resources/{:id}

  • Delete the specified resource from the Whispir platform under the particular workspace.



  • JSON
  • XML

API endpoint

Default workspace example

https://api.<region>.whispir.com/resources/?apikey=<your_api_key>
Content-Type: application/vnd.whispir.resource-v1+json

   

Workspace specific example

https://api.<region>.whispir.com/workspaces/{:id}/resources/?apikey=<your_api_key>
Content-Type: application/vnd.whispir.resource-v1+json

 

Methods supported

GET
POST
PUT
DELETE