Skip to main content

REST API

The documentation of the api can be found in Api Docs page. This article defines the resources available in the Vcards integration API.

Access token

In order to access the API it is required having an accessToken. Once you have an accessToken you must include it in every request as a HTTP header

AccessToken: "AccessToken"

If you need to try different API calls you can do it from the same Api Docs page, by using the "authorize" button

image-1688635717307.png

Create a new tag

Screenshot from 2024-09-24 11-16-11.png

Creates a new tag in the team.

Parameters:

Name Type Description Required
name string Full name Yes
collection string Collection code where the tag is created Yes
email string Email related to the tag Yes
phone string Phone number YesNo
position object Position of the tag YesNo
mobile-phone string Mobile phone number YesNo
address string Address of the tag YesNo
department string Department of the tag YesNo
  • sku: A string representing the SKU (Stock Keeping Unit) used to identify the tag to be updated.
  • values: A JSON object containing the tag details. Each of the keys belongs to the slug of the field in the tag.

Request Body:

  • Media type: application/json
  • Example request body: 
     {
    "name": "Full name",
    "collection" : "2423AX23",
    "email": "[email protected]",
    "phone": "+1234567890",
    "position": { 
      "en":  "CEO", 
      "es": "Director General" 
    },
    "mobile-phone": "+1234567890",
    "address": "1234 Main St, City, Country",
    "department" : "Marketing"
}

Responses:

201 - Success
  • Media type: application/json
  • Example response: 
    {
    "code": "BVHWSTMGL",
    "sku": "ABC000",
    "values": {
      "name": "Full name",
      "email": "[email protected]",
      "phone": "+1234567890",
      "position": { 
        "en":  "CEO", 
        "es": "Director General" 
      },
      "mobile-phone": "+1234567890",
      "address": "1234 Main St, City, Country",
      "department" : "Marketing"
    }
}

Show tag detail

Retrieves tag details by the given SKU. The SKU is a unique reference for the tag.

Parameters:

Name Type Description Required
sku string SKU code Yes
  • sku: A string representing the SKU (Stock Keeping Unit) used to retrieve specific tag details.

Responses:

200 - Success
  • Media type: application/json
  • Example response: 
    {
    "code": "BVHWSTMGL",
    "sku": "ABC000",
    "values": {
      "name": "Full name",
      "email": "[email protected]",
      "phone": "+1234567890",
      "position": { 
        "en":  "CEO", 
        "es": "Director General" 
      },
      "mobile-phone": "+1234567890",
      "address": "1234 Main St, City, Country",
      "department" : "Marketing"

    }
}
404 - Not Found
  • Description: Tag not found in the team for the given SKU.

Edit a tag

Updates the details of an existing tag identified by the SKU.

Parameters:

Name Type Description Required
sku string SKU code Yes
  • sku: A string representing the SKU (Stock Keeping Unit) used to identify the tag to be updated.

Request Body:

  • Media type: application/json
  • Example request body: 
     {
  "code": "BVHWSTMGL",
  "sku": "ABC000",
  "values": {
    "name": "Full name",
    "email": "[email protected]",
    "phone": "+1234567890",
    "position": { 
      "en":  "CEO", 
      "es": "Director General" 
    },
    "mobile-phone": "+1234567890",
    "address": "1234 Main St, City, Country",
    "department" : "Marketing"

  }
}

Responses:

200 - Success

  • Media type: application/json

  • Example response:

    {
    "code": "BVHWSTMGL",
    "sku": "ABC000",
    "values": {
      "name": "Full name",
      "email": "[email protected]",
      "phone": "+1234567890",
      "position": { 
        "en":  "CEO", 
        "es": "Director General" 
      },
      "mobile-phone": "+1234567890",
      "address": "1234 Main St, City, Country",
      "department" : "Marketing"

    }
}

  • Description: Successful update of the tag.

Delete a tag

Deletes a tag from the team by the given SKU.

Parameters:

Name Type Description Required
sku string SKU code Yes
  • sku: A string representing the SKU (Stock Keeping Unit) used to delete the tag.

Responses:

204 - Success
  • Description: Tag successfully deleted from the team.
  • Media type: application/json
Back to top