Update an OAuth2 connection

PUT /api/v1/oauth/connections/{oauthConnection_uuid}
application/json

Body

  • label string

    The label of the OAuth2 connection

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • provider object

      The name of the provider the OAuth2 connection is for

    • access_token_expires_at string

      The expiry date of the access token. If blank, the access token will not expire.

    • refresh_token_expires_at string

      The expiry date of the refresh token. If blank, the refresh token will not expire.

    • refresh_authorization_url string

      The authorization URL to refresh the connection. Only visible when listing all OAuth2 providers.

    • label string

      The user generated label for the OAuth2 connection.
PUT /api/v1/oauth/connections/{oauthConnection_uuid} 
curl \
 -X PUT https://api.plannrcrm.com/api/v1/oauth/connections/oauthConnection_uuid \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"label":"My Fundment Account 1"}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "label": "My Fundment Account 1"
}
Response examples (200) 
{
  "uuid": "040d3750-ac6f-4156-a4db-d329ef0c3d65",
  "label": "My Fundment Account 1",
  "provider": {
    "name": "fundment",
    "label": "Fundment",
    "logo_url": "https://api.plannrcrm.com/imgs/fundment-banner.png",
    "authorization_url": "https://plannr.valet/oauth/fundment/authorize"
  },
  "created_at": "2024-10-16T11:10:17+01:00",
  "updated_at": "2024-10-16T11:10:17+01:00",
  "access_token_expires_at": "2024-10-16T14:10:17.921921Z",
  "refresh_token_expires_at": "2025-10-16T10:10:17.921955Z",
  "refresh_authorization_url": "https://plannr.valet/oauth/fundment/authorize/9ca5e072-6ea4-4ec9-b14d-0a2f32a5dffb"
}