Skip to content

Semify Enterprise REST APIs (2.0.0)

This is the documentation for the Semify Endpoints based on the OpenAPI 3.0 specification. You can find out more about Swagger at http://swagger.io.

Find more info here
Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL

https://www.semify.com

API Support

developers@semify.com

License

Apache 2.0

Languages
Servers
Mock server

https://developers.semify.com/_mock/openapi/

Sandbox

https://uat.services.semify.com/

Production Server

https://services.semify.com/

accounts

Operations related to accounts.

Operations

keywords

Operations related to keywords.

Operations

reports

Reporting endpoints.

Operations

products

Product management endpoints.

Operations

authentication

Authentication/authorization endpoints.

Operations

campaigns

Campaigns and related operations.

Operations

google gbp accounts

Google GBP account endpoints.

Operations

Create for GBP account provisioning or claims

Request

This endpoint allows for GBP account provisioning or claims

Security
JWTAuth
Bodyapplication/jsonrequired

Needed fields to perform gbp account provisioning

ticket_idinteger

Please enter a ticket id.

Example: 12345
gpidstring

Please enter an external account identifier

Example: "TI XXXXX179"
nobstring

Please enter a name of the business

Example: "Best Plumbing Services"
addressstring

Please enter the address of the business

Example: "2308 West Cone Blvd, Suite 201, Greensboro, NC 27408"
website_urlstring

Please enter the website url

Example: "https://www.businessname.com"
access_confirmedboolean

Please enter a name of the business

Example: true
curl -i -X POST \
  https://developers.semify.com/_mock/openapi/api/v1/google/gbp/accounts \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ticket_id": 12345,
    "gpid": "TI XXXXX179",
    "nob": "Best Plumbing Services",
    "address": "2308 West Cone Blvd, Suite 201, Greensboro, NC 27408",
    "website_url": "https://www.businessname.com",
    "access_confirmed": true
  }'

Responses

Successful google gbp account ticket creation

Bodyapplication/json
dataobjectrequired
Example: {"campaign_id":471549,"task_field_id":830,"task_id":36147273}
data.​task_idinteger(int64)
Example: 36147273
data.​campaign_idinteger(int64)
Example: 471549
data.​task_field_idinteger(int64)
Example: 830
errorbooleanrequired
Example: false
paginationobjectrequired
Example: {"totalPages":1,"maxRows":0,"offset":0,"page":1,"totalRecords":1}
pagination.​totalPagesinteger(int64)
Example: 1
pagination.​maxRowsinteger(int64)
Example: 0
pagination.​offsetinteger(int64)
Example: 0
pagination.​pageinteger(int64)
Example: 1
pagination.​totalRecordsinteger(int64)
Example: 1
messagesArray of stringsrequired
Example: ["Google GBP account task successfully created."]
Response
application/json
{
  "data": {
    "campaign_id": 471549,
    "task_field_id": 830,
    "task_id": 36147273
  },
  "error": false,
  "pagination": {
    "totalPages": 1,
    "maxRows": 0,
    "offset": 0,
    "page": 1,
    "totalRecords": 1
  },
  "messages": [
    "Google GBP account task successfully created."
  ]
}