Create a link that connects a user's Google account

Send the user to url. They sign in with Google, using the application's own Google client when it has one, and return to return_url with status=connected and connection_id, or status=cancelled, failed, expired or used. Links last 30 minutes and work once.

POST/v1/users/{id}/connect-links

Authorization

Authorizationstringrequired

Bearer tak_… — an application API key. Keep it on your backend; all resources are scoped to that application.

Create an application key →

Path parameters

idstringrequired

Min length: 1

Body application/json

providerstringrequired

Allowed: "google""gmail""drive""calendar"

return_urlstringrequired

Format: uri · Max length: 2048

Response

201Create a link that connects a user's Google account

X-Request-Idstring

Server-generated request identifier for logs and support.

application/json

idstringrequired

Min length: 1

user_idstringrequired

Min length: 1

providerstringrequired

Allowed: "google""gmail""drive""calendar"

return_urlstringrequired

urlstringrequired

created_atstringrequired

Format: date-time · Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

expires_atstringrequired

4XX400 invalid input; 401 missing/revoked credentials; 403 disallowed operation/application; 404 missing or inaccessible resource; 409 conflicting submission/version/state; 413 body too large; 415 unsupported content type. Inspect error.code, not message text.

X-Request-Idstring

Server-generated request identifier for logs and support.

application/json

errorobjectrequired

Object fields

codestringrequired

messagestringrequired

request_idstringrequired

Additional keys: any

5XX500 unexpected failure or 503 unavailable dependency. A failed response does not prove that a submission was not committed. Retry job/flow admission with the same key and body.

X-Request-Idstring

Server-generated request identifier for logs and support.

application/json

errorobjectrequired

Object fields

codestringrequired

messagestringrequired

request_idstringrequired

Additional keys: any