The Party Link object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

primary_role string required
secondary_role string
primary_party string
secondary_party string
The Party Link object 
{
  "id": "party-link_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "primary_role": "primary_role_example",
  "secondary_role": "secondary_role_example",
  "primary_party": "primary_party_example",
  "secondary_party": "secondary_party_example"
}
GET /api/accounts/party-link/{id}

Retrieve a party link

Retrieves the details of an existing party link. Supply the unique party link ID that was returned from a previous request.

Path parameters

id string required

The identifier of the party link to retrieve.

Returns

Returns the party link object if a valid identifier was provided.

GET /api/accounts/party-link/{id} 
curl https://api.overplane.dev/api/accounts/party-link/party-link_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "party-link_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "primary_role": "primary_role_example",
  "secondary_role": "secondary_role_example",
  "primary_party": "primary_party_example",
  "secondary_party": "secondary_party_example"
}
GET /api/accounts/party-link

List all party links

Returns a list of party links. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of party link objects.

GET /api/accounts/party-link 
curl https://api.overplane.dev/api/accounts/party-link \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "party-link_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "primary_role": "primary_role_example",
      "secondary_role": "secondary_role_example",
      "primary_party": "primary_party_example",
      "secondary_party": "secondary_party_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/party-link

Create a party link

Creates a new party link object.

Body parameters

primary_role string required
secondary_role string
primary_party string
secondary_party string

Returns

Returns the newly created party link object if the call succeeded.

POST /api/accounts/party-link 
curl https://api.overplane.dev/api/accounts/party-link \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"primary_role":"primary_role_example"}'
Response 
{
  "id": "party-link_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "primary_role": "primary_role_example",
  "secondary_role": "secondary_role_example",
  "primary_party": "primary_party_example",
  "secondary_party": "secondary_party_example"
}
PATCH /api/accounts/party-link/{id}

Update a party link

Updates the specified party link by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the party link to update.

Body parameters

primary_role string
secondary_role string
primary_party string
secondary_party string

Returns

Returns the updated party link object.

PATCH /api/accounts/party-link/{id} 
curl https://api.overplane.dev/api/accounts/party-link/party-link_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"primary_role":"primary_role_example","secondary_role":"secondary_role_example"}'
Response 
{
  "id": "party-link_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "primary_role": "primary_role_example",
  "secondary_role": "secondary_role_example",
  "primary_party": "primary_party_example",
  "secondary_party": "secondary_party_example"
}
DELETE /api/accounts/party-link/{id}

Delete a party link

Permanently deletes a party link. This cannot be undone.

Path parameters

id string required

The identifier of the party link to delete.

Returns

Returns a confirmation that the party link has been deleted.

DELETE /api/accounts/party-link/{id} 
curl https://api.overplane.dev/api/accounts/party-link/party-link_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "party-link_abc123",
  "deleted": true
}