Agendize Developers API

Agendize Actions API

Save & Share Buttons

Resource representation

{ "id": {string}, "name": {string}, "type": {string}, "firstName": {string}, "lastName": {string}, "jobTitle" {string}, "websiteURL": {string} "company": { "addesse": { "address": {string}, "city": {string}, "state": {string}, "zipCode": {string}, "country": {string} }, "phoneNumber": {string}, "faxNumber": {string}, "emailAddress": {string}, "phonePhoneNumber": {string), }, "personal": { "addesse": { "address": {string}, "city": {string}, "state": {string}, "zipCode": {string}, "country": {string} }, "phoneNumber": {string}, "emailAddress": {string}, "phonePhoneNumber": {string), }, "start": { "dateTime": {string}, "timeZone": {string} }, "end": { "dateTime": {string}, "timeZone": {string} }, "currentURL": {boolean}, "url": {string} }
Parameter name Value Description
id string Identifier of the save & share button. Read-only
name string Name of the save & share button.
type string Type of button. Values: "contact" to save & share personal or/and company information, "event" to save & share an event, "url" to share & share a web page URL.
firstName string First name of the contact. Only for a contact button.
lastName string Last name of the contact. Only for a contact button.
jobTitle string Job title of the contact. Only for a contact button.
websiteURL string Web site URL of the contact. Only for a contact button.
personal object Personal information for "contact" button. Only for a contact button.
personal.address object Personal address for "contact" button.
personal.address.address string Line of address of the personal address.
personal.address.city string City of the personal address.
personal.address.state string State of the personal address.
personal.address.zipCode string Zip code of the personal address.
personal.address.country string Country of the personal address.
personal.phoneNumber string Personal phone number of the contact information.
personal.mobilePhoneNumber string Personal mobile phone number of the contact information.
company object Company information for "contact" button. Only for a contact button.
company.address object Company address for "contact" button.
company.address.address string Line of address of the company address.
company.address.city string City of the company address.
company.address.state string State of the company address.
company.address.zipCode string Zip code of the company address.
company.address.country string Country of the company address.
company.phoneNumber string Company phone number of the contact information.
company.faxNumber string Company fax number of the contact information.
company.emailAddress string Company email address of the contact information.
start object The start time of the event. Only for an event button.
start.dateTime string The time, as a combined date-time value (formatted according to RFC 3339, without time zone information).
start.timeZone string The time zone. Possible values can be found here. The default value is the time zone of the company.
end object The end time of the event. Only for an event button.
start.dateTime string The time, as a combined date-time value (formatted according to RFC 3339, without time zone information).
start.timeZone string The time zone. Possible values can be found here. The default value is the time zone of the company.
currentURL boolean If the URL to save & share is the URL of the current page where the button is published. Only for an URL button.
url string URL to save & share. Only for an URL button.

Delete

Deletes an entry on the save & share button list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

DELETE https://api.agendize.com/api/2.0/actions/buttons/{buttonId}

Parameters

Parameter name Value Description
Path parameters
buttonId string Save & Share button identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.

Get

Returns an entry of the save & share button list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.0/actions/buttons/{buttonId}

Parameters

Parameter name Value Description
Path parameters
buttonId string Save & Share button identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Save & Share button resource in the response body.

List

Returns entries on the save & share button list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.0/actions/buttons

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{ items: [Save & Share button Resource] }

Insert

Adds an entry to the save & share button list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

POST https://api.agendize.com/api/2.0/actions/buttons

Request body

In the request body, supply a Save & Share button resource with the following properties:

Parameter name Value Description
Required Properties
name string Name of the Save & Share button.

Response

If successful, this method returns a Save & Share button resource in the response body.

Update

Updates an entry on the save & share button list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

PUT https://api.agendize.com/api/2.0/actions/buttons/{buttonId}

Parameters

Parameter name Value Description
Path parameters
buttonId string Save & Share button identifier.

Request body

In the request body, supply a Save & Share button resource with the following properties:

Parameter name Value Description
Optional Properties
name string Name of the Save & Share button.

Response

If successful, this method returns a Save & Share button resource in the response body.