email-accounts

Reconnect existing email accounts.

This can be a large request and may take some time to complete. But you will get response immediately after the request is submitted.

On request of this API, you will receive a requestId that can be used to check the status of the import process.

To check the status of the import process, you can use the /v1/email-accounts/connect/status API.

After completion you will receive a CSV file link containing the email account import details.

post/v1/email-accounts/reconnect

Request

Base URL
https://developer.saleshandy.com (the document declares no server; this is the origin it was published from)
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/saleshandy/apis/develop-with-saleshandy/docs/v1/email-accounts/reconnect/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

emailAccountIdsnumber[] required

Array of email account IDs to be toggled on.

Example request

{
  "emailAccountIds": [
    "1Gz3xlNwr9",
    "ajzR8xpPAq",
    "vXwAZr6P8q"
  ]
}

Response

The email accounts connection process has been initiated successfully. Please wait while we connect your email accounts. You may check the status using this API /v1/email-accounts/connect/status/{{requestId}}.

unknown required

Example response

{
  "message": "The email accounts connection process has been initiated successfully. Please wait while we connect your email accounts. You may check the status using this API `/v1/email-accounts/connect/status/{{requestId}}`.",
  "payload": {
    "requestId": "129a184"
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.