Skip to main content
POST
/
sendLinks
Send Link API
curl --request POST \
  --url https://stagingstores.xoxoday.com/chef/v1/oauth/api/sendLinks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "xoxo_link.mutation.generateLinkEmail",
  "tag": "xoxo_link",
  "variables": {
    "data": {
      "campaignId": 123,
      "email_ids": "email1@domain.com,email2@domain.com",
      "link_expiry": "19-03-2023"
    }
  }
}
'
{
  "data": {
    "generateLink": {
      "success": 1,
      "message": "Links created successfully"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://help-plum.xoxoday.com/llms.txt

Use this file to discover all available pages before exploring further.

PropertyTypeDescription
campaignIdStringUnique identifier of the campaign for which links are to be generated.
email_idsStringComma-separated list of recipient email addresses (or a single email).
link_expiryStringExpiry date for the link(s) (format: DD-MM-YYYY).

​
Response Schema

PropertyTypeDescription
dataobjectRoot response object.
data.generateLinkobjectContainer for link-sending operation.
data.generateLink.successnumberAPI execution status (1 = success).
data.generateLink.messagestringMessage returned by the API (e.g., “Links created successfully”).

Authorizations

​
Authorization
string
header
required

Authorization: Bearer <access_token>

Body

application/json
​
query
enum<string>
default:xoxo_link.mutation.generateLinkEmail
required

Always use xoxo_link.mutation.generateLinkEmail.

Available options:
xoxo_link.mutation.generateLinkEmail
​
tag
enum<string>
default:xoxo_link
required

Always use xoxo_link.

Available options:
xoxo_link
​
variables
object
required

Response

Links sent successfully to all recipients.

​
data
object