Add a participant to an order

POST/v1/api/store/{team_slug}/sales_order/{hash_id}/participant

v1Operation ID v1_public_sales_order_participant_store

Participants are the people who can receive an order's messages: contacts of the customer, or guests with just an email address. Each has its own email and text message switches and a status (all by default). A message goes to the participants you list in it: by email to everyone listed who has an email address, whatever the switches or status; by text only to those with can_receive_sms and status all or message. Every id in a message must be a current participant of that order, or the message is refused (see Send a message to the customer).

Adds one participant. Send type: "contact" with a contact_id, or type: "guest" with an email. The answer is the participant; use its id in messages. {hash_id} is the order's id (for example V4keXwwxMQyXw7); the ord_ unique key is not accepted here.

Permission

Any member of the team.

Business rules

• contact_id is required for contact, email for guest.
• can_receive_mail and can_receive_sms are required.

Side effects

• Sends nothing.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• hash_idstringrequired

  The sales order's or quote's id (a hash id). The ord_ unique key and the order number do not work here.

  • Example V4keXwwxMQyXw7

Request body

application/json, required.

• can_receive_mailbooleanrequired

  Whether they get messages by email.

• can_receive_smsbooleanrequired

  Whether they get text messages.

• typestringrequired

  contact for one of the customer's contacts, guest for anyone else.

  • One of: "contact", "guest"
• contact_idstring

  Required for contact: the contact's id.

• emailstring (email)

  Required for guest.

• namestring

  The guest's name.

• statusstring

  Default all.

  • One of: "all", "message", "notification", "disabled"

More examples (1)

A guest

curl

curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/sales_order/V4keXwwxMQyXw7/participant' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "can_receive_mail": true,    "can_receive_sms": false,    "email": "alex@example.com",    "name": "Alex Rivera",    "type": "guest"  }'

Response

200Successful response.

• dataobjectrequired

  A participant.

  Child fields (11)

  • idstringrequired

    The participant id that messages use.

  • statusstringrequired

    all, message, notification or disabled.

  • can_receive_mailboolean
  • can_receive_smsboolean
  • contact_idstring | null

    Set for contacts; null for guests.

  • emailstring | null
  • namestring | null
  • order_idstring | null
  • phonestring | null
  • trashedboolean
  • typestring | null

    contact or guest.

• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  A required field is missing or the email is not valid.

  Fix

  Send the fields for the chosen type.

Related

• GETList the participants of an order/v1/api/store/{team_slug}/sales_order/{hash_id}/participant
• POSTSend a message to the customer/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/message
• GETList a customer's contacts/v1/api/store/{team_slug}/customer/{hash_id}/contact

Example request

curl

curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/sales_order/V4keXwwxMQyXw7/participant' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "can_receive_mail": true,    "can_receive_sms": false,    "contact_id": "7fobq9tQvOi5EG",    "status": "all",    "type": "contact"  }'

Example response 200

Response

{
  "data": {
    "can_receive_mail": true,
    "can_receive_sms": false,
    "contact_id": "7fobq9tQvOi5EG",
    "email": "alex@example.com",
    "id": "LBbXMRNWVof2bd",
    "name": "Alex Rivera",
    "order_id": "V4keXwwxMQyXw7",
    "phone": null,
    "status": "all",
    "trashed": false,
    "type": "contact"
  },
  "status": 200,
  "success": true
}