OnAutomate API V1.1.1

Welcome to onautomate Api docs.

User

GET /v1/users/

https://link.amtssl.com/v1/users/

Get all agency users.

Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys



AUTHORIZATION

Bearer Token

Token

<token>

Example Request

curl --location --request GET 'https://link.amtssl.com/v1/users/' \

--header 'Authorization: Bearer <token>'

Example Response

Unauthorized

Bad Request. please contact support!

{

"msg": "Unauthorized"

}

{

"msg": "Bad Request"

}

Headers

Content-Type: application/json

Headers

Content-Type: application/json

Successful response

200 OK

Body

{ "users": [ { "id": "3g3ltlwEJBoXArLowV3e", "firstName": "John", "lastName": "Deo", "email": "john@deo.com", "roles": { "type": "agency", "role": "admin", "locationIds": [ "C2QujeCh8ZnC7al2InWR" ] }, "permissions": { "campaignsEnabled": true, "campaignsReadOnly": false, "contactsEnabled": true, "workflowsEnabled": true, "triggersEnabled": true, "funnelsEnabled": true, "websitesEnabled": false, "opportunitiesEnabled": true, "dashboardStatsEnabled": true, "bulkRequestsEnabled": true, "appointmentsEnabled": true, "reviewsEnabled": true, "onlineListingsEnabled": true, "phoneCallEnabled": true, "conversationsEnabled": true, "assignedDataOnly": false, "adwordsReportingEnabled": false, "membershipEnabled": false, "facebookAdsReportingEnabled": false, "attributionsReportingEnabled": false, "settingsEnabled": true, "tagsEnabled": true, "leadValueEnabled": true, "marketingEnabled": true } }, { "id": "3g3ltlwEJBoXArLowV3e", "firstName": "John", "lastName": "Deo", "email": "john@deo.com", "roles": { "type": "agency", "role": "admin", "locationIds": [ "C2QujeCh8ZnC7al2InWR" ] }, "permissions": { "campaignsEnabled": true, "campaignsReadOnly": false, "contactsEnabled": true, "workflowsEnabled": true, "triggersEnabled": true, "funnelsEnabled": true, "websitesEnabled": false, "opportunitiesEnabled": true, "dashboardStatsEnabled": true, "bulkRequestsEnabled": true, "appointmentsEnabled": true, "reviewsEnabled": true, "onlineListingsEnabled": true, "phoneCallEnabled": true, "conversationsEnabled": true, "assignedDataOnly": false, "adwordsReportingEnabled": false, "membershipEnabled": false, "facebookAdsReportingEnabled": false, "attributionsReportingEnabled": false, "settingsEnabled": true, "tagsEnabled": true, "leadValueEnabled": true, "marketingEnabled": true } } ] }

Headers

Content-Type: application/json

POST /v1/users/

https://link.amtssl.com/v1/users/

Create a User.

Small description for the field allow options.

type fields will allow these options:

  • account
  • agency

role fields will allow these options:

  • admin
  • user

locationIds fields will allow valid locations id of the agency.

Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

AUTHORIZATION

Bearer Token

Token

<token>

HEADERS

Content-Type

application/json

Body raw

{ "firstName": "John", "lastName": "Deo", "email": "john@deo.com", "password": "*******", "type": "account", "role": "admin", "locationIds": [ "C2QujeCh8ZnC7al2InWR" ], "permissions": { "campaignsEnabled": true, "campaignsReadOnly": false, "contactsEnabled": true, "workflowsEnabled": true, "triggersEnabled": true, "funnelsEnabled": true, "websitesEnabled": false, "opportunitiesEnabled": true, "dashboardStatsEnabled": true, "bulkRequestsEnabled": true, "appointmentsEnabled": true, "reviewsEnabled": true, "onlineListingsEnabled": true, "phoneCallEnabled": true, "conversationsEnabled": true, "assignedDataOnly": false, "adwordsReportingEnabled": false, "membershipEnabled": false, "facebookAdsReportingEnabled": false, "attributionsReportingEnabled": false, "settingsEnabled": true, "tagsEnabled": true, "leadValueEnabled": true, "marketingEnabled": true } }

Example Request

curl --location --request POST 'https://link.amtssl.com/v1/users/' \ --header 'Authorization: Bearer ' \ --data-raw '{ "firstName": "John", "lastName": "Deo", "email": "john@deo.com", "password": "*******", "type": "account", "role": "admin", "locationIds": [ "C2QujeCh8ZnC7al2InWR" ], "permissions": { "campaignsEnabled": true, "campaignsReadOnly": false, "contactsEnabled": true, "workflowsEnabled": true, "triggersEnabled": true, "funnelsEnabled": true, "websitesEnabled": false, "opportunitiesEnabled": true, "dashboardStatsEnabled": true, "bulkRequestsEnabled": true, "appointmentsEnabled": true, "reviewsEnabled": true, "onlineListingsEnabled": true, "phoneCallEnabled": true, "conversationsEnabled": true, "assignedDataOnly": false, "adwordsReportingEnabled": false, "membershipEnabled": false, "facebookAdsReportingEnabled": false, "attributionsReportingEnabled": false, "settingsEnabled": true, "tagsEnabled": true, "leadValueEnabled": true, "marketingEnabled": true } }'

Example Response

Unauthorized

Bad Request. please contact support!

401 Unauthorized

Body

{

"msg": "Unauthorized"

}

400 Bad Request

Body

{

"msg": "Bad Request"

}

Headers

Content-Type: application/json

Headers

Content-Type: application/json

Unprocessable Entity

422 Unprocessable Entity (WebDAV) (RFC 4918)

Body

{ "id": "OW59k4IchTgKjIDy3VMO", "name": "Test Team", "members": [ { "id": "mnUXmpG2MhhHKmjegzBZ", "name": "Elon Musk", "email": "elon@musk.com" }, { "id": "mnUXmpG2MhhHKmjegzBZ", "name": "Elon Musk", "email": "elon@musk.com" } ], "calendarConfig": { "calendarName": "Test Calendar", "description": "Desc.", "slug": "slug", "link": "/widget/appointment/slug", "shouldAssignContactToTeamMember": false, "shouldSkipAssigningContactForExisting": false } }

Headers

Content-Type: application/json

Successful response 

200 OK

Body

{ "id": "3g3ltlwEJBoXArLowV3e", "firstName": "John", "lastName": "Deo", "email": "john@deo.com", "roles": { "type": "agency", "role": "admin", "locationIds": [ "C2QujeCh8ZnC7al2InWR" ] }, "permissions": { "campaignsEnabled": true, "campaignsReadOnly": false, "contactsEnabled": true, "workflowsEnabled": true, "triggersEnabled": true, "funnelsEnabled": true, "websitesEnabled": false, "opportunitiesEnabled": true, "dashboardStatsEnabled": true, "bulkRequestsEnabled": true, "appointmentsEnabled": true, "reviewsEnabled": true, "onlineListingsEnabled": true, "phoneCallEnabled": true, "conversationsEnabled": true, "assignedDataOnly": false, "adwordsReportingEnabled": false, "membershipEnabled": false, "facebookAdsReportingEnabled": false, "attributionsReportingEnabled": false, "settingsEnabled": true, "tagsEnabled": true, "leadValueEnabled": true, "marketingEnabled": true } }

Headers

Content-Type: application/json

GET /v1/users/location

https://link.amtssl.com/v1/users/location

Get user by location.

Authorization:

Provide your location api key (Bearer Token).

AUTHORIZATION

Bearer Token

Token

<token>

Example Request

curl --location --request GET 'https://link.amtssl.com/v1/users/location' \

--header 'Authorization: Bearer <token>'

Example Response

Bad Request. please contact support!

Unauthorized

{

"msg": "Bad Request"

}

{

"msg": "Unauthorized"

}

Headers

Content-Type: application/json

Headers

Content-Type: application/json

Successful Response

200 OK

Body

{ "id": "OW59k4IchTgKjIDy3VMO", "name": "Test Team", "members": [ { "id": "mnUXmpG2MhhHKmjegzBZ", "name": "Elon Musk", "email": "elon@musk.com" }, { "id": "mnUXmpG2MhhHKmjegzBZ", "name": "Elon Musk", "email": "elon@musk.com" } ], "calendarConfig": { "calendarName": "Test Calendar", "description": "Desc.", "slug": "slug", "link": "/widget/appointment/slug", "shouldAssignContactToTeamMember": false, "shouldSkipAssigningContactForExisting": false } }

GET /v1/users/:userId

https://link.amtssl.com/v1/users/:userId

Get agency by user id.

Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

AUTHORIZATION

Bearer Token

Token

<token>

PATH VARIABLES

userId

082goXVW3lIExEQPOnd3

(Required) User Id

Example Request

curl --location --request GET 'https://link.amtssl.com/v1/users/:userId' \

--header 'Authorization: Bearer <token>'

Example Response

Bad Request. please contact support!

Unauthorized

400 Bad Request

{

"msg": "Bad Request"

}

401 Unauthorized

{

"msg": "Unauthorized"

}

Headers

Content-Type: application/json

Headers

Content-Type: application/json

Successful response

200 OK

{ "id": "3g3ltlwEJBoXArLowV3e", "firstName": "John", "lastName": "Deo", "email": "john@deo.com", "roles": { "type": "agency", "role": "admin", "locationIds": [ "C2QujeCh8ZnC7al2InWR" ] }, "permissions": { "campaignsEnabled": true, "campaignsReadOnly": false, "contactsEnabled": true, "workflowsEnabled": true, "triggersEnabled": true, "funnelsEnabled": true, "websitesEnabled": false, "opportunitiesEnabled": true, "dashboardStatsEnabled": true, "bulkRequestsEnabled": true, "appointmentsEnabled": true, "reviewsEnabled": true, "onlineListingsEnabled": true, "phoneCallEnabled": true, "conversationsEnabled": true, "assignedDataOnly": false, "adwordsReportingEnabled": false, "membershipEnabled": false, "facebookAdsReportingEnabled": false, "attributionsReportingEnabled": false, "settingsEnabled": true, "tagsEnabled": true, "leadValueEnabled": true, "marketingEnabled": true } }

PUT /v1/users/:userId

https://link.amtssl.com/v1/users/:userId

Update a User.

Small description for the field allow options.

type fields will allow these options:

  • account
  • agency

role fields will allow these options:

  • admin
  • user

locationIds fields will allow valid locations id of the agency.

Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

AUTHORIZATION

Bearer Token

Token

<token>

HEADERS

Content-Type

application/json

PATH VARIABLES

userId

082goXVW3lIExEQPOnd3

(Required) User Id

Body raw

{ "firstName": "John", "lastName": "Deo", "email": "john@deo.com", "password": "*******", "type": "account", "role": "admin", "locationIds": [ "C2QujeCh8ZnC7al2InWR" ], "permissions": { "campaignsEnabled": true, "campaignsReadOnly": false, "contactsEnabled": true, "workflowsEnabled": true, "triggersEnabled": true, "funnelsEnabled": true, "websitesEnabled": false, "opportunitiesEnabled": true, "dashboardStatsEnabled": true, "bulkRequestsEnabled": true, "appointmentsEnabled": true, "reviewsEnabled": true, "onlineListingsEnabled": true, "phoneCallEnabled": true, "conversationsEnabled": true, "assignedDataOnly": false, "adwordsReportingEnabled": false, "membershipEnabled": false, "facebookAdsReportingEnabled": false, "attributionsReportingEnabled": false, "settingsEnabled": true, "tagsEnabled": true, "leadValueEnabled": true, "marketingEnabled": true } }

Example Request

curl --location --request POST 'https://link.amtssl.com/v1/users/' \ --header 'Authorization: Bearer ' \ --data-raw '{ "firstName": "John", "lastName": "Deo", "email": "john@deo.com", "password": "*******", "type": "account", "role": "admin", "locationIds": [ "C2QujeCh8ZnC7al2InWR" ], "permissions": { "campaignsEnabled": true, "campaignsReadOnly": false, "contactsEnabled": true, "workflowsEnabled": true, "triggersEnabled": true, "funnelsEnabled": true, "websitesEnabled": false, "opportunitiesEnabled": true, "dashboardStatsEnabled": true, "bulkRequestsEnabled": true, "appointmentsEnabled": true, "reviewsEnabled": true, "onlineListingsEnabled": true, "phoneCallEnabled": true, "conversationsEnabled": true, "assignedDataOnly": false, "adwordsReportingEnabled": false, "membershipEnabled": false, "facebookAdsReportingEnabled": false, "attributionsReportingEnabled": false, "settingsEnabled": true, "tagsEnabled": true, "leadValueEnabled": true, "marketingEnabled": true } }'

Example Response

Unauthorized

Bad Request. please contact support!

401 Unauthorized

Body

{

"msg": "Unauthorized"

}

400 Bad Request

Body

{

"msg": "Bad Request"

}

Headers

Content-Type: application/json

Headers

Content-Type: application/json

Unprocessable Entity

422 Unprocessable Entity (WebDAV) (RFC 4918)

Body

{ "id": "OW59k4IchTgKjIDy3VMO", "name": "Test Team", "members": [ { "id": "mnUXmpG2MhhHKmjegzBZ", "name": "Elon Musk", "email": "elon@musk.com" }, { "id": "mnUXmpG2MhhHKmjegzBZ", "name": "Elon Musk", "email": "elon@musk.com" } ], "calendarConfig": { "calendarName": "Test Calendar", "description": "Desc.", "slug": "slug", "link": "/widget/appointment/slug", "shouldAssignContactToTeamMember": false, "shouldSkipAssigningContactForExisting": false } }

Headers

Content-Type: application/json

Successful response 

200 OK

Body

{ "id": "3g3ltlwEJBoXArLowV3e", "firstName": "John", "lastName": "Deo", "email": "john@deo.com", "roles": { "type": "agency", "role": "admin", "locationIds": [ "C2QujeCh8ZnC7al2InWR" ] }, "permissions": { "campaignsEnabled": true, "campaignsReadOnly": false, "contactsEnabled": true, "workflowsEnabled": true, "triggersEnabled": true, "funnelsEnabled": true, "websitesEnabled": false, "opportunitiesEnabled": true, "dashboardStatsEnabled": true, "bulkRequestsEnabled": true, "appointmentsEnabled": true, "reviewsEnabled": true, "onlineListingsEnabled": true, "phoneCallEnabled": true, "conversationsEnabled": true, "assignedDataOnly": false, "adwordsReportingEnabled": false, "membershipEnabled": false, "facebookAdsReportingEnabled": false, "attributionsReportingEnabled": false, "settingsEnabled": true, "tagsEnabled": true, "leadValueEnabled": true, "marketingEnabled": true } }

Headers

Content-Type: application/json

DEL /v1/users/:userId

https://link.amtssl.com/v1/users/:userId

Delete one of user.

Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API key

AUTHORIZATION

Bearer Token

Token

<token>

PATH VARIABLES

userId

082goXVW3lIExEQPOnd3

(Required) User Id

Example Request

curl --location --request DELETE 'https://link.amtssl.com/v1/users/:userId' \

--header 'Authorization: Bearer <token>'

Example Response

Unauthorized

Bad Request. please contact support!

Successful response

401 Unauthorized

Body

{

"msg": "Unauthorized"

}

400 Bad Request

Body

{

"msg": "Bad Request"

}

200 OK

Body

""

Headers

Content-Type: application/json

Headers

Content-Type: application/json

Headers

Content-Type: application/json