Plecto

https://docs.plecto.com/kb/guide/en
Admin
Plecto is a business intelligence platform that helps users visualize data, create real-time...
Tokens:19,401
Snippets:115
Trust Score:9.7
Update:11 months ago
Show doc for...
Tokens:
Raw
### Plecto API Single Registration Example

Source: https://docs.plecto.com/kb/guide/en/how-to-send-data-to-plectos-api-8jyWZ97bO9/Steps/2186713

This JSON object demonstrates the structure for a single registration request to the Plecto API. It includes mandatory keys like 'data_source', 'member_api_provider', 'member_api_id', 'member_name', and 'external_id', along with a custom 'Value' field.

```json
{
    "data_source": "70a0d1ef780a4cd98f541c214601030e",
    "member_api_provider": "Postman",
    "member_api_id": "101032",
    "member_name": "Employee X",
    "external_id": "12345",
    "Value": "100"
}
```

--------------------------------

### Plecto API Bulk Registration Example

Source: https://docs.plecto.com/kb/guide/en/how-to-send-data-to-plectos-api-8jyWZ97bO9/Steps/2186713

This JSON array shows how to send multiple registrations in a single request to the Plecto API. Each object within the array represents a single registration, adhering to the same mandatory key requirements as individual registrations.

```json
[
{
    "data_source": "70a0d1kg780a4cd98f541c214601030e",
    "member_api_provider": "Postman",
    "member_api_id": "101032",
    "member_name": "Employee X",
    "external_id": "0p23oi5",
    "Value": "100"
},
{
    "data_source": "70a0d1kg780a4cd98f541c214601030e",
    "member_api_provider": "Postman",
    "member_api_id": "101032",
    "member_name": "Employee X",
    "external_id": "3ae89oq",
    "Value": "150"
}
]
```

--------------------------------

### SQL SELECT Statement for Plecto Integration

Source: https://docs.plecto.com/kb/guide/en/sql-UfQgG4LsHg/Steps/2386589

This SQL query is designed to extract sales data for Plecto integration. It selects relevant user and sales information, aliasing them to match Plecto's required fields. The query filters data based on date ranges using placeholders for dynamic filtering. Ensure the selected fields ('member_id', 'member_name', 'date', 'reference', 'team_name') match the requirements for Plecto data sources.

```sql
SELECT
    sales_table.user_id as member_id,
    sales_table.user_name as member_name,
    sales_table.date as date,
    sales_table.id as reference,
    sales_table.sales_team as team_name 
FROM
    sales_table
WHERE
    sales_table.date > {{ last_update_time }}
    AND
    sales_table.date < {{ upper_date_limit }}
```

--------------------------------

### Plecto API Registration with Member UUID Example

Source: https://docs.plecto.com/kb/guide/en/how-to-send-data-to-plectos-api-8jyWZ97bO9/Steps/2186713

This JSON object illustrates a registration request using a 'member' UUID instead of 'member_api_provider', 'member_api_id', and 'member_name'. It includes the mandatory 'data_source', 'member', and 'external_id' keys, along with a 'date' field.

```json
{
    "data_source": "70a0d1kg780a4cd98f541c214601030e",
    "member": "d40b0139bc7a48e09128521ac5ed089d",
    "external_id": "0p23oi5",
    "date": "2022-12-31T10:22:55"
}
```

--------------------------------

### V2 API Endpoints Overview

Source: https://docs.plecto.com/kb/guide/en/overview-of-plecto-api-endpoints-Qvm3c3ucy1/Steps/3879885

This section lists the available endpoints for the Plecto API V2. These endpoints cover various functionalities including dashboards, data sources, registrations, members, teams, slideshows, and formulas.

```APIDOC
## Plecto API V2 Endpoints

### Description
Overview of available V2 endpoints.

### Base URL
`https://app.plecto.com/api/v2/`

### Endpoints
*   `/dashboards/`
*   `/datasources/`
*   `/registrations/`
*   `/members/`
*   `/teams/`
    *   `/my-teams/`
*   `/slideshows/`
    *   `/screens/`
    *   `/screen-devices/`
    *   `/devices/`
*   `/favorites/`
*   `/formulas/`
```

--------------------------------

### V3 API Endpoints Overview

Source: https://docs.plecto.com/kb/guide/en/overview-of-plecto-api-endpoints-Qvm3c3ucy1/Steps/3879885

This section lists the available endpoints for the Plecto API V3. These endpoints cover functionalities related to achievement types and posts.

```APIDOC
## Plecto API V3 Endpoints

### Description
Overview of available V3 endpoints.

### Base URL
`https://app.plecto.com/api/v3/`

### Endpoints
*   `/achievement-types/`
    *   `/achievement-type-icons/`
*   `/posts/
```

--------------------------------

### POST /api/v2/datasources/

Source: https://docs.plecto.com/kb/guide/en/how-to-send-data-to-plectos-api-8jyWZ97bO9/Steps/2186713

Create a new API data source in Plecto. You need to provide a title and fields for the data source.

```APIDOC
## POST /api/v2/datasources/

### Description
Creates a new API data source in Plecto. Requires a `title` and `fields` in the request body. Fields define the structure of the data that can be sent to this data source.

### Method
POST

### Endpoint
`https://app.plecto.com/api/v2/datasources/`

### Parameters
#### Request Body
- **title** (string) - Required - The name of the data source.
- **fields** (array) - Required - An array of field objects, where each object defines a field with `name`, `input` type, and optionally `default_value`.
  - **name** (string) - Required - The name of the field.
  - **input** (string) - Required - The type of input for the field (e.g., "DecimalInput", "TextInput").
  - **default_value** (string) - Optional - The default value for the field.

### Request Example
```json
{
    "title": "New API Data Source",
    "fields": [
        {
            "name": "Number of Units",
            "input": "DecimalInput",
            "default_value": ""
        },
        {
            "name": "Product Name",
            "input": "TextInput",
            "default_value": "Coffee"
        }
    ]
}
```

### Response
#### Success Response (201 Created)
- **id** (string) - The unique identifier for the newly created data source.
- **title** (string) - The name of the data source.
- **fields** (array) - The fields defined for the data source.

#### Response Example
```json
{
    "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "title": "New API Data Source",
    "fields": [
        {
            "name": "Number of Units",
            "input": "DecimalInput",
            "default_value": ""
        },
        {
            "name": "Product Name",
            "input": "TextInput",
            "default_value": "Coffee"
        }
    ]
}
```

### Note
Updating fields of an existing data source is not supported via the API. This must be done through the Plecto UI.
```

--------------------------------

### POST /api/v2/members/ - Invite Employees

Source: https://docs.plecto.com/kb/guide/en/how-to-add-employees-to-plecto-via-api-hEwfU5QsjP/Steps/3348467

This endpoint is used to invite employees to Plecto, distinct from simply creating a member record. It utilizes the same POST request to the /api/v2/members/ endpoint but is intended for initiating the invitation process.

```APIDOC
## POST /api/v2/members/

### Description
This endpoint can be used to invite employees to Plecto. It follows the same structure as creating a member but serves the purpose of sending an invitation.

### Method
POST

### Endpoint
https://app.plecto.com/api/v2/members/

### Parameters
(Refer to the 'Create Members (Employees)' endpoint for detailed parameter information. The same parameters apply for inviting employees, with the intent of the request being to send an invitation.)

### Request Example
(Use the same request body structure as the 'Create Members (Employees)' endpoint. The system interprets this request as an invitation.)
```json
{
  "updating_api_provider_id": "API Provider ID",
  "updating_api_provider": "MY API",
  "updating_api_provider_email": "api.email@example.com",
  "name": "John Doe",
  "is_active": true,
  "teams": []
}
```

### Response
#### Success Response (200)
(Refer to the 'Create Members (Employees)' endpoint for success response details. The response confirms the member creation, which initiates the invitation process.)

#### Response Example
(Refer to the 'Create Members (Employees)' endpoint for response examples.)
```

--------------------------------

### POST /api/v2/registrations/

Source: https://docs.plecto.com/kb/guide/en/how-to-send-data-to-plectos-api-8jyWZ97bO9/Steps/2186713

Add multiple registrations to a data source. Requires `data_source` and `member` UUIDs, along with the fields defined for the data source.

```APIDOC
## POST /api/v2/registrations/

### Description
Adds multiple registrations to a specified data source. Each registration requires a `data_source` UUID and a `member` UUID, along with the data fields defined for that data source.

### Method
POST

### Endpoint
`https://app.plecto.com/api/v2/registrations/`

### Parameters
#### Request Body
- **data_source** (string) - Required - The UUID of the data source to which registrations will be added.
- **member** (string) - Required - The UUID of the member associated with the registrations.
- **external_id** (string) - Required - A unique identifier for the registration.
- **[Dynamic Fields]** (various) - Required - Fields defined in the data source (e.g., "Product Name", "Number of Units"). The type and name of these fields must match the data source configuration.

### Request Example
```json
[
    {
        "data_source": "UUID",
        "member": "UUID",
        "external_id": "api-ds-1",
        "Product Name": "Ice cream",
        "Number of Units": "10"
    },
    {
        "data_source": "UUID",
        "member": "UUID",
        "external_id": "api-ds-2",
        "Product Name": "Sorbet",
        "Number of Units": "15"
    },
    {
        "data_source": "UUID",
        "member": "UUID",
        "external_id": "api-ds-3",
        "Product Name": "Coffee",
        "Number of Units": "30"
    }
]
```

### Response
#### Success Response (200 OK or 207 Multi-Status)
- The response typically indicates the success or failure of each registration addition. Specific details may vary.

#### Response Example
(Response structure for bulk registration may vary, often indicating success/failure per item)
```json
{
  "message": "Registrations processed successfully."
}
```

### Note
Ensure that the `data_source` and `member` UUIDs are valid and exist within your Plecto organization.
```

--------------------------------

### API Requests (Default) Limit

Source: https://docs.plecto.com/kb/guide/en/api-limits-vFN7INmk9g/Steps/2277498

This section details the global API request limit for default endpoints and lists the affected endpoints.

```APIDOC
## API Requests (Default) Limit

### Description
These are the default API requests that are limited to 3600 requests per hour. These limits apply to all interactions with the listed endpoints.

### Method
Applies to GET, POST, PUT, DELETE requests to the specified endpoints.

### Endpoint
- /contest-widgets
- /dashboards
- /devices
- /favorites
- /graphs
- /images
- /leaderboards
- /numbers
- /screens
- /tables
- /text
- /timelines

### Parameters
No specific parameters are mentioned for these limits, as they apply to the general usage of the endpoints.

### Request Example
N/A

### Response
N/A

### Error Handling
Exceeding the limit will likely result in rate limiting errors (e.g., 429 Too Many Requests).
```

--------------------------------

### POST /api/v2/registrations/

Source: https://docs.plecto.com/kb/guide/en/how-to-send-data-to-plectos-api-8jyWZ97bO9/Steps/2186713

Endpoint for creating new registrations in a Plecto data source. Requires mandatory keys like data_source, member (or member details), and external_id.

```APIDOC
## POST /api/v2/registrations/

### Description
This endpoint allows you to create new registrations in your Plecto data source. It requires specific mandatory keys in the request body to identify the data source, the member associated with the registration, and a unique external identifier.

### Method
POST

### Endpoint
`https://app.plecto.com/api/v2/registrations/`

### Parameters
#### Request Body
- **data_source** (string) - Required - The UUID of your data source.
- **member** (string) - Required (mutually exclusive with member_api_provider, member_api_id, member_name) - The UUID of an existing employee profile in Plecto.
- **member_api_provider** (string) - Required (mutually exclusive with member) - The name of your system providing the member data.
- **member_api_id** (string) - Required (mutually exclusive with member) - The member ID from your system. This, along with `member_api_provider`, uniquely identifies an employee.
- **member_name** (string) - Optional - The name of the member. This will be displayed in Plecto and can be updated if `member_api_provider` and `member_api_id` remain the same.
- **external_id** (string) - Required - A unique identifier for each registration. This serves as the reference ID in Plecto.
- **Value** (string) - Required - Custom field for the data source, representing the value of the registration.

### Request Example
```json
{
    "data_source": "70a0d1ef780a4cd98f541c214601030e",
    "member_api_provider": "Postman",
    "member_api_id": "101032",
    "member_name": "Employee X",
    "external_id": "12345",
    "Value": "100"
}
```

### Response
#### Success Response (200)
- **id** (string) - The UUID of the newly created or updated registration in Plecto.

#### Response Example
```json
{
    "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```

#### Error Handling
- **Duplicated registrations found**: Returned if multiple registrations in a bulk request share the same `external_id`.
```json
{
  "message": "Duplicated registrations found",
  "id": "<your id>"
}
```
```

--------------------------------

### API Requests (Registrations) Limit

Source: https://docs.plecto.com/kb/guide/en/api-limits-vFN7INmk9g/Steps/2277498

This section details the API request limits for the /registrations endpoint, including hourly limits and per-request item limits.

```APIDOC
## API Requests (Registrations) Limit

### Description
These API requests are limited to 3600 requests per hour and a maximum of 100 items per request. These limitations apply to all interactions with the /registrations endpoint.

### Method
Applies to GET, POST, PUT, DELETE requests to the /registrations endpoint.

### Endpoint
/registrations

### Parameters
#### Query Parameters
- **items** (integer) - Optional - The number of items to include per request (max 100).

### Request Example
```json
POST /registrations
{
  "items": 100,
  "data": [
    // ... registration data ...
  ]
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation of successful registration.

#### Response Example
```json
{
  "message": "Registrations processed successfully."
}
```

### Error Handling
Exceeding the hourly limit or the items per request limit will likely result in rate limiting errors (e.g., 429 Too Many Requests).
```

--------------------------------

### Alternative Member Identification (using `member` UUID)

Source: https://docs.plecto.com/kb/guide/en/how-to-send-data-to-plectos-api-8jyWZ97bO9/Steps/2186713

Demonstrates how to use a member UUID directly for registration, bypassing `member_api_provider`, `member_api_id`, and `member_name`.

```APIDOC
## POST /api/v2/registrations/ (with Member UUID)

### Description
This example shows how to register data using a direct member UUID, which links the registration to an existing employee profile in Plecto without needing API provider details.

### Method
POST

### Endpoint
`https://app.plecto.com/api/v2/registrations/`

### Parameters
#### Request Body
- **data_source** (string) - Required - The UUID of your data source.
- **member** (string) - Required - The UUID of an existing employee profile in Plecto.
- **external_id** (string) - Required - A unique identifier for each registration.
- **date** (string) - Optional - The date of the registration in ISO 8601 format.

### Request Example
```json
{
    "data_source": "70a0d1kg780a4cd98f541c214601030e",
    "member": "d40b0139bc7a48e09128521ac5ed089d",
    "external_id": "0p23oi5",
    "date": "2022-12-31T10:22:55"
}
```

### Response
#### Success Response (200)
- **id** (string) - The UUID of the newly created or updated registration in Plecto.

#### Response Example
```json
{
    "id": "f0e9d8c7-b6a5-4321-fedc-ba9876543210"
}
```
```

--------------------------------

### Plecto API Base URL

Source: https://docs.plecto.com/kb/guide/en/how-to-send-data-to-plectos-api-8jyWZ97bO9/Steps/2186713

All Plecto API endpoints are accessible via the following base URL. This is the foundation for all API requests.

```APIDOC
## Base URL

### Description
This is the base URL for all Plecto API endpoints.

### URL
`https://app.plecto.com/api/v2/`

### Usage
All endpoint paths should be appended to this base URL.
```

--------------------------------

### Plecto API Authentication

Source: https://docs.plecto.com/kb/guide/en/how-to-send-data-to-plectos-api-8jyWZ97bO9/Steps/2186713

Plecto API uses Basic Authentication. You need to send your email and password with each request. It's recommended to create a dedicated user for each integration to manage credentials securely.

```APIDOC
## Authentication

### Description
The Plecto API uses Basic Authentication. This involves sending your email and password with each API request.

### Method
Basic Authentication (HTTP)

### Details
- **Credentials**: Your Plecto account email and password.
- **Recommendation**: Create a separate employee profile in Plecto for each integration to avoid sharing credentials.
- **Permissions**: Ensure the user account has the necessary access rights to the Plecto areas relevant to the API endpoints being used.
```

--------------------------------

### Retrieve API Registrations

Source: https://docs.plecto.com/kb/guide/en/how-to-retrieve-or-delete-api-registrations-7w1wXhzx1c/Steps/2277497

Retrieve all registrations from a specified data source. This is useful for importing Plecto data into other systems.

```APIDOC
## GET /api/v2/registrations/

### Description
Retrieves all registrations from a specified data source. This endpoint allows you to import your Plecto data into another system.

### Method
GET

### Endpoint
https://app.plecto.com/api/v2/registrations/

### Parameters
#### Query Parameters
- **data_source** (string) - Required - The unique UUID of your data source.

### Request Example
```
GET https://app.plecto.com/api/v2/registrations/?data_source=<data_source_uuid>
```

### Response
#### Success Response (200)
- **registrations** (array) - An array containing all registrations from the selected data source.

#### Response Example
```json
{
  "registrations": [
    {
      "uuid": "<registration_uuid_1>",
      "field1": "value1",
      "field2": "value2"
    },
    {
      "uuid": "<registration_uuid_2>",
      "field1": "value3",
      "field2": "value4"
    }
  ]
}
```
```

--------------------------------

### Bulk Registrations

Source: https://docs.plecto.com/kb/guide/en/how-to-send-data-to-plectos-api-8jyWZ97bO9/Steps/2186713

Endpoint for creating multiple registrations in a single API request. Supports up to 100 registrations per request. Each registration must have a unique external_id.

```APIDOC
## POST /api/v2/registrations/ (Bulk)

### Description
This endpoint allows for the creation of multiple registrations in a single API request, improving efficiency for batch data entry. A maximum of 100 registrations can be included in one request body.

### Method
POST

### Endpoint
`https://app.plecto.com/api/v2/registrations/`

### Parameters
#### Request Body
A JSON array containing registration objects. Each object must include:
- **data_source** (string) - Required - The UUID of your data source.
- **member** (string) - Required (mutually exclusive with member_api_provider, member_api_id, member_name) - The UUID of an existing employee profile in Plecto.
- **member_api_provider** (string) - Required (mutually exclusive with member) - The name of your system providing the member data.
- **member_api_id** (string) - Required (mutually exclusive with member) - The member ID from your system.
- **member_name** (string) - Optional - The name of the member.
- **external_id** (string) - Required - A unique identifier for each registration within the bulk request. Cannot be duplicated within the same request.
- **Value** (string) - Required - Custom field for the data source, representing the value of the registration.

### Request Example (Multiple Registrations)
```json
[
    {
        "data_source": "70a0d1kg780a4cd98f541c214601030e",
        "member_api_provider": "Postman",
        "member_api_id": "101032",
        "member_name": "Employee X",
        "external_id": "0p23oi5",
        "Value": "100"
    },
    {
        "data_source": "70a0d1kg780a4cd98f541c214601030e",
        "member_api_provider": "Postman",
        "member_api_id": "101032",
        "member_name": "Employee X",
        "external_id": "3ae89oq",
        "Value": "150"
    }
]
```

### Response
#### Success Response (200)
- **id** (string) - The UUID of the newly created or updated registration in Plecto.

#### Response Example
```json
{
    "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```

#### Error Handling
- **Duplicated registrations found**: Returned if multiple registrations in a bulk request share the same `external_id`.
```json
{
  "message": "Duplicated registrations found",
  "id": "<your id>"
}
```
```

--------------------------------

### Create Plecto API Data Source Structure (JSON)

Source: https://docs.plecto.com/kb/guide/en/how-to-send-data-to-plectos-api-8jyWZ97bO9/Steps/2186713

This JSON structure defines a new API data source for Plecto. It includes a title for the data source and a list of fields, each with a name, input type, and an optional default value. This structure is used when creating a new data source via the API.

```json
{
    "title": "New API Data Source",
    "fields": [
        {
            "name": "Number of Units",
            "input": "DecimalInput",
            "default_value": ""
        },
        {
            "name": "Product Name",
            "input": "TextInput",
            "default_value": "Coffee"
        }
    ]
}
```

--------------------------------

### Delete API Registration

Source: https://docs.plecto.com/kb/guide/en/how-to-retrieve-or-delete-api-registrations-7w1wXhzx1c/Steps/2277497

Deletes a single API registration. You need the data source UUID and the specific registration UUID to perform this action.

```APIDOC
## DELETE /api/v2/registrations/{data_source_uuid}/{registration_uuid}/

### Description
Deletes a single registration from a data source. Each request can only delete one registration.

### Method
DELETE

### Endpoint
https://app.plecto.com/api/v2/registrations/<data_source_uuid>/<registration_uuid>/

### Parameters
#### Path Parameters
- **data_source_uuid** (string) - Required - The unique UUID of your data source.
- **registration_uuid** (string) - Required - The unique UUID of the registration to delete.

### Request Example
```
DELETE https://app.plecto.com/api/v2/registrations/<data_source_uuid>/<registration_uuid>/
```

### Response
#### Success Response (200)
- (No specific fields mentioned, typically returns a success status or confirmation)

#### Response Example
```json
{
  "message": "Registration deleted successfully."
}
```
```

--------------------------------

### Add Plecto API Registration Data (JSON)

Source: https://docs.plecto.com/kb/guide/en/how-to-send-data-to-plectos-api-8jyWZ97bO9/Steps/2186713

This JSON array represents multiple registration records to be added to a Plecto data source via the API. Each object contains essential keys like 'data_source' and 'member' UUIDs, along with 'external_id' and the data fields defined for the data source (e.g., 'Product Name', 'Number of Units').

```json
[
    {
        "data_source": "UUID",
        "member": "UUID",
        "external_id": "api-ds-1",
        "Product Name": "Ice cream",
        "Number of Units": "10"
    },
    {
        "data_source": "UUID",
        "member": "UUID",
        "external_id": "api-ds-2",
        "Product Name": "Sorbet",
        "Number of Units": "15"
    },
    {
        "data_source": "UUID",
        "member": "UUID",
        "external_id": "api-ds-3",
        "Product Name": "Coffee",
        "Number of Units": "30"
    }
]
```

--------------------------------

### POST /api/v2/members/ - Create Members (Employees)

Source: https://docs.plecto.com/kb/guide/en/how-to-add-employees-to-plecto-via-api-hEwfU5QsjP/Steps/3348467

This endpoint allows you to create new members (employees) in Plecto without granting them login access. It requires essential fields like updating_api_provider_id, updating_api_provider, updating_api_provider_email, name, and is_active. The teams field is mandatory but can be left blank.

```APIDOC
## POST /api/v2/members/

### Description
Allows creation of new members (employees) in Plecto without login access. Requires essential fields and supports optional fields for additional details.

### Method
POST

### Endpoint
https://app.plecto.com/api/v2/members/

### Parameters
#### Request Body
- **updating_api_provider_id** (string) - Required - The API Provider ID, shown as External ID in the employee profile. Cannot be overwritten.
- **updating_api_provider** (string) - Required - The System name or Data supplier. Updating this adds a new Data supplier.
- **updating_api_provider_email** (string) - Required - The user's email address. Cannot be overwritten.
- **name** (string) - Required - The name of the user. Automatically splits into first and last name. Can be overwritten.
- **is_active** (boolean) - Required - Set to `false` to deactivate the user.
- **teams** (array) - Required - Mandatory but can be left blank. Specify team IDs to assign the user to teams.
- **title** (string) - Optional - The user's job title.
- **display_name** (string) - Optional - A display name for the user.
- **manager** (string) - Optional - The ID of the user's manager.
- **managed_teams** (array) - Optional - A list of team IDs that the user manages.

### Request Example
```json
{
  "updating_api_provider_id": "API Provider ID",
  "updating_api_provider": "MY API",
  "updating_api_provider_email": "api.email@example.com",
  "name": "John Doe",
  "is_active": true,
  "teams": [],
  "title": "Senior API Specialist",
  "display_name": "Anchorman",
  "manager": "e1c111ebbc1111be1cbb1c111ced1111",
  "managed_teams": []
}
```

### Response
#### Success Response (200)
- **member_id** (string) - The unique identifier for the newly created member.
- **updating_api_provider_id** (string) - The provided API Provider ID.
- **updating_api_provider** (string) - The provided Data supplier name.
- **updating_api_provider_email** (string) - The provided email address.
- **name** (string) - The full name of the member.
- **is_active** (boolean) - Indicates if the member is active.
- **teams** (array) - A list of team objects the member belongs to.
- **title** (string) - The member's title, if provided.
- **display_name** (string) - The member's display name, if provided.
- **manager** (object) - An object containing details of the member's manager, if provided.
- **managed_teams** (array) - A list of team objects the member manages, if provided.

#### Response Example
```json
{
  "member_id": "a1b2c3d4e5f678901234567890abcdef",
  "updating_api_provider_id": "API Provider ID",
  "updating_api_provider": "MY API",
  "updating_api_provider_email": "api.email@example.com",
  "name": "John Doe",
  "is_active": true,
  "teams": [],
  "title": "Senior API Specialist",
  "display_name": "Anchorman",
  "manager": {
    "id": "e1c111ebbc1111be1cbb1c111ced1111",
    "name": "Jane Smith"
  },
  "managed_teams": []
}
```
```

--------------------------------

### PUT /api/v2/registrations/

Source: https://docs.plecto.com/kb/guide/en/how-to-send-data-to-plectos-api-8jyWZ97bO9/Steps/2186713

Updates existing registration data or employee information in Plecto. It uses `data_source` and `external_id` to identify registrations, and `member_api_provider` and `member_api_id` for employees. You can also optionally set a `date` field to modify the 'Created date'.

```APIDOC
## PUT /api/v2/registrations/

### Description
Updates existing registration data or employee information in Plecto. It uses `data_source` and `external_id` to identify registrations, and `member_api_provider` and `member_api_id` for employees. You can also optionally set a `date` field to modify the 'Created date'.

### Method
PUT

### Endpoint
https://app.plecto.com/api/v2/registrations/

### Parameters
#### Request Body
- **data_source** (string) - Required - Identifies the data source for the registration.
- **external_id** (string) - Required - The external ID of the registration in Plecto.
- **member_api_provider** (string) - Optional - The API provider for the employee.
- **member_api_id** (string) - Optional - The API ID for the employee.
- **member_name** (string) - Optional - The name of the employee to update.
- **date** (string) - Optional - The date to set for the registration in 'YYYY-MM-DDTHH:MM:SS' format.

### Request Example
```json
{
  "data_source": "my_datasource",
  "external_id": "reg123",
  "member_api_provider": "provider_x",
  "member_api_id": "emp456",
  "member_name": "Curtis Miller",
  "date": "2022-12-31T10:22:55"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the update was successful.

#### Response Example
```json
{
  "message": "Registration updated successfully."
}
```
```
Tokens:
Raw