Invites

Email or text users a URL connecting them to Link.

  1. Adjust the invite text or branding through Invite settings in Console.
  2. Send invites to users via email, SMS, or both.
  3. Re-send an invite if a user needs to return to Link, or lost their original invite.

#Send an invite

post/v2/invites
  • Immediately sends an invite via email, SMS, or both.
  • Returns an invite object in the response.
Request body
  • #
    full_namestring
    required

    Name of the invite recipient.

  • #
    phone_numberstring
    optional

    Phone number of the invite recipient.

    *Required when email is empty.

  • #
    emailstring
    optional

    Email address of the invite recipient.

    *Required when phone_number is empty.

  • #
    flow_idstring
    optional

    ID used to customize the user's experience in Link.

    Must be the ID of an email/SMS template.

  • #
    dds_configobject
    optional

    Unencrypted target deposit destination. Adds a deposit switching flow after the user connects their payroll accounts.

  • #
    override_invite_templateobject
    optional

    Overrides the text and branding of the email/SMS template specified via the flow_id property (or default invite settings, if no templates exist).

The invite object
  • #
    idstring (uuid)

    Unique ID of the invite.

  • #
    userstring (uuid)

    ID of the user.

  • #
    user_tokenstring

    User token required to initialize embedded instances of Link for the user.

    This user token will expire after one hour. A new user token can be created at any time using the /user-tokens API endpoint.

  • #
    emailstring

    Email of the invite recipient.

  • #
    phone_numberstring

    Phone number of the invite recipient.

  • #
    full_namestring

    Name of the invite recipient.

  • #
    revoked_atstring (datetime)

    Timestamp (ISO 8601) when the invite was revoked.

  • #
    statusstring (enum)

    The invite's status.

  • #
    urlstring

    URL included in the invite that connects the user to Link.

  • #
    created_atstring (datetime)

    Timestamp (ISO 8601) when the invite was created.

  • #
    updated_atstring (datetime)

    Timestamp (ISO 8601) when the invite was updated.

    The timestamp is updated after re-sending or revoking an invite.

  • #
    invited_atstring (datetime)

    Timestamp (ISO 8601) when the invite was sent.

    The timestamp is updated after re-sending or revoking an invite.

  • #
    (Deprecated) invite_template_idstring (uuid)

    Customization ID.
    — Deprecated in favor of override_invite_template.

Example Request
1curl --request POST \
2     --url https://api.argyle.com/v2/invites \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json' \
5     --data '{
6        "full_name": "Sarah Longfield",
7        "phone_number": "212-555-5555",
8        "email": "[email protected]"
9     }'
Example Response
1{
2  "id": "0424137bc-edc5-35de-c1b5-1c3cddb4b227",
3  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
4  "user_token": "bcJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRfaWEiOiIxNDRhMTRkNS04YzEzLTQzZGYtOTI4Ni01OWY4NjFkOWEyMDIiLCJleHAiOjE2ODc3OTMzODAsImZpZCI6IjUyYWM3ZFFiLTI1MzAtNGYyNy04NTZlLTkwOTk1ZDA4NWJkMCIsImlhdCI6MTY4Nzc4OTc4MCwiaXNzIjoiYXJneWxlLWNvcmUtYXV1aC1kZXYiLCJqdGki2eJiZGI4YTExMS0wYzFjLTRiNjEtYmI5NS04ZGQ0YzA0OGQwNzUiLCJzdWIiOiIwMTg4ZjgxYy0zZTFkLTRlZDEtMjEyYy02NmB3YzE4YzVjYzMiLCJ1c2VyX2lkIjoiMDE4OGY4MWMtM2UxZC00ZWQxLTIxMmMtNjZhN2MxN2M1Y2MzIn0.TNiZojOiiXtPVamyCDjz4f2GwR4TA8x6JR3RwjTECjY",
5  "email": "[email protected]",
6  "phone_number": "212-555-5555",
7  "full_name": "Sarah Longfield",
8  "revoked_at": null,
9  "status": "sent",
10  "url": "https://console.argyle.com/add-work-accounts/0424137bc-edc5-35de-c1b5-1c3cddb4b227",
11  "created_at": "2023-03-09T23:57:05.756Z",
12  "updated_at": "2023-03-09T23:57:05.756Z",
13  "invited_at": "2023-03-09T23:57:05.756Z",
14  "invite_template_id": null
15}

#Retrieve an invite

get/v2/invites/{id}

Retrieves an invite object.

Path parameters
  • #
    idstring (uuid)
    required

    ID of the invite to be retrieved.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v2/invites/{id} \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1{
2  "id": "0424137bc-edc5-35de-c1b5-1c3cddb4b227",
3  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
4  "user_token": "bcJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRfaWEiOiIxNDRhMTRkNS04YzEzLTQzZGYtOTI4Ni01OWY4NjFkOWEyMDIiLCJleHAiOjE2ODc3OTMzODAsImZpZCI6IjUyYWM3ZFFiLTI1MzAtNGYyNy04NTZlLTkwOTk1ZDA4NWJkMCIsImlhdCI6MTY4Nzc4OTc4MCwiaXNzIjoiYXJneWxlLWNvcmUtYXV1aC1kZXYiLCJqdGki2eJiZGI4YTExMS0wYzFjLTRiNjEtYmI5NS04ZGQ0YzA0OGQwNzUiLCJzdWIiOiIwMTg4ZjgxYy0zZTFkLTRlZDEtMjEyYy02NmB3YzE4YzVjYzMiLCJ1c2VyX2lkIjoiMDE4OGY4MWMtM2UxZC00ZWQxLTIxMmMtNjZhN2MxN2M1Y2MzIn0.TNiZojOiiXtPVamyCDjz4f2GwR4TA8x6JR3RwjTECjY",
5  "email": "[email protected]",
6  "phone_number": "212-555-5555",
7  "full_name": "Sarah Longfield",
8  "revoked_at": null,
9  "status": "sent",
10  "url": "https://console.argyle.com/add-work-accounts/0424137bc-edc5-35de-c1b5-1c3cddb4b227",
11  "created_at": "2023-03-09T23:57:05.756Z",
12  "updated_at": "2023-03-09T23:57:05.756Z",
13  "invited_at": "2023-03-09T23:57:05.756Z",
14  "invite_template_id": null
15}

#Re-send an invite

post/v2/invites/{id}

Re-sends a previously sent invite. Updates the updated_at and invited_at time.

Path parameters
  • #
    idstring (uuid)
    required

    ID of the invite to be re-sent.

Example Request
1curl --request POST \
2     --url https://api.argyle.com/v2/invites/{id} \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1{
2  "id": "0424137bc-edc5-35de-c1b5-1c3cddb4b227",
3  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
4  "user_token": "bcJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRfaWEiOiIxNDRhMTRkNS04YzEzLTQzZGYtOTI4Ni01OWY4NjFkOWEyMDIiLCJleHAiOjE2ODc3OTMzODAsImZpZCI6IjUyYWM3ZFFiLTI1MzAtNGYyNy04NTZlLTkwOTk1ZDA4NWJkMCIsImlhdCI6MTY4Nzc4OTc4MCwiaXNzIjoiYXJneWxlLWNvcmUtYXV1aC1kZXYiLCJqdGki2eJiZGI4YTExMS0wYzFjLTRiNjEtYmI5NS04ZGQ0YzA0OGQwNzUiLCJzdWIiOiIwMTg4ZjgxYy0zZTFkLTRlZDEtMjEyYy02NmB3YzE4YzVjYzMiLCJ1c2VyX2lkIjoiMDE4OGY4MWMtM2UxZC00ZWQxLTIxMmMtNjZhN2MxN2M1Y2MzIn0.TNiZojOiiXtPVamyCDjz4f2GwR4TA8x6JR3RwjTECjY",
5  "email": "[email protected]",
6  "phone_number": "212-555-5555",
7  "full_name": "Sarah Longfield",
8  "revoked_at": null,
9  "status": "sent",
10  "url": "https://console.argyle.com/add-work-accounts/0424137bc-edc5-35de-c1b5-1c3cddb4b227",
11  "created_at": "2023-03-09T23:57:05.756Z",
12  "updated_at": "2023-04-06T05:42:13.278Z",
13  "invited_at": "2023-04-06T05:42:13.278Z",
14  "invite_template_id": null
15}

#Revoke an invite

post/v2/invites/{id}/revoke

Invalidates a previously sent invite.

If a user clicks a revoked invite URL, the landing page will notify the user the invite has expired.

Path parameters
  • #
    idstring (uuid)
    required

    ID of the invite to be revoked.

Example Request
1curl --request POST \
2     --url https://api.argyle.com/v2/invites/{id}/revoke \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1{
2  "id": "0424137bc-edc5-35de-c1b5-1c3cddb4b227",
3  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
4  "user_token": "bcJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRfaWEiOiIxNDRhMTRkNS04YzEzLTQzZGYtOTI4Ni01OWY4NjFkOWEyMDIiLCJleHAiOjE2ODc3OTMzODAsImZpZCI6IjUyYWM3ZFFiLTI1MzAtNGYyNy04NTZlLTkwOTk1ZDA4NWJkMCIsImlhdCI6MTY4Nzc4OTc4MCwiaXNzIjoiYXJneWxlLWNvcmUtYXV1aC1kZXYiLCJqdGki2eJiZGI4YTExMS0wYzFjLTRiNjEtYmI5NS04ZGQ0YzA0OGQwNzUiLCJzdWIiOiIwMTg4ZjgxYy0zZTFkLTRlZDEtMjEyYy02NmB3YzE4YzVjYzMiLCJ1c2VyX2lkIjoiMDE4OGY4MWMtM2UxZC00ZWQxLTIxMmMtNjZhN2MxN2M1Y2MzIn0.TNiZojOiiXtPVamyCDjz4f2GwR4TA8x6JR3RwjTECjY",
5  "email": "[email protected]",
6  "phone_number": "212-555-5555",
7  "full_name": "Sarah Longfield",
8  "revoked_at": "2023-03-11T04:22:16.312Z",
9  "status": "revoked",
10  "url": "https://console.argyle.com/add-work-accounts/0424137bc-edc5-35de-c1b5-1c3cddb4b227",
11  "created_at": "2023-03-09T23:57:05.756Z",
12  "updated_at": "2023-03-11T04:22:13.537Z",
13  "invited_at": "2023-03-11T04:22:13.537Z",
14  "invite_template_id": null
15}

#List all invites

get/v2/invites

Returns an object containing all invite objects.

Query parameters
  • #
    limitinteger
    optional

    Number of invite objects returned per page. Default: 10. Maximum: 200.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v2/invites?limit=2 \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1{
2  "0": {
3    "id": "0424137bc-edc5-35de-c1b5-1c3cddb4b227",
4    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
5    "user_token": null,
6    "email": "[email protected]",
7    "phone_number": "212-555-5555",
8    "full_name": "Sarah Longfield",
9    "revoked_at": null,
10    "status": "completed",
11    "url": "https://console.argyle.com/add-work-accounts/0424137bc-edc5-35de-c1b5-1c3cddb4b227",
12    "created_at": "2023-03-09T23:57:05.756Z",
13    "updated_at": "2023-03-09T23:57:05.756Z",
14    "invited_at": "2023-03-09T23:57:05.756Z",
15    "invite_template_id": null
16  },
17  "1": {
18    "id": "0186c5b8-8fa1-67b3-39af-14b3e18da8a7",
19    "user": "f3041cb5-bf31-21cb-aa05-df294c161fd9",
20    "user_token": null,
21    "email": "[email protected]",
22    "phone_number": "212-867-5309",
23    "full_name": "Bob Jones",
24    "revoked_at": null,
25    "status": "initiated",
26    "url": "https://console.argyle.com/add-work-accounts/f3041cb5-bf31-21cb-aa05-df294c161fd9",
27    "created_at": "2023-03-10T01:22:36.432Z",
28    "updated_at": "2023-03-10T01:22:36.432Z",
29    "invited_at": "2023-03-10T01:22:36.432Z",
30    "invite_template_id": null
31  }
32}
Updating Argyle status...
© 2023 Argyle Systems Inc.argyle.com