POST /transfers/consignments/{consignmentId}

Path parameters

  • consignmentId string Required

    The unique identifier of a consignment

Body

  • target_emails array[string] Required

    Array of email's target

  • message string
  • expiration number

    Expiration in days. Eg. 90

Responses

  • 201

    Transfer is created with success

    Hide response attributes Show response attributes object
    • success boolean Required

      Default value is true.

    • body object Required
      Hide body attribute Show body attribute object
      • id string

        The unique identifier of a transfer
  • 400

    Missing required body parameters

    Hide response attributes Show response attributes object
    • success boolean Required

      If request is succeed

      Default value is false.

    • message string Required

      A human readable error message

    • context string Required

      Context of error
  • 500

    Unexpected error

    Hide response attributes Show response attributes object
    • success boolean Required

      If request is succeed

      Default value is false.

    • message string Required

      A human readable error message

    • context string Required

      Context of error
POST /transfers/consignments/{consignmentId} 
curl \
 -X POST https://api.ziplo.fr/v1/public/transfers/consignments/{consignmentId} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"target_emails":["string"],"message":"string","expiration":42.0}'
Request example 
{
  "target_emails": [
    "string"
  ],
  "message": "string",
  "expiration": 42.0
}
Request examples 
{
  "target_emails": [
    "string"
  ],
  "message": "string",
  "expiration": 42.0
}
Response examples (201) 
{
  "success": true,
  "body": {
    "id": "string"
  }
}
Response examples (201) 
{
  "success": true,
  "body": {
    "id": "string"
  }
}
Response examples (400) 
{
  "success": false,
  "message": "string",
  "context": "string"
}
Response examples (400) 
{
  "success": false,
  "message": "string",
  "context": "string"
}
Response examples (500) 
{
  "success": false,
  "message": "string",
  "context": "string"
}
Response examples (500) 
{
  "success": false,
  "message": "string",
  "context": "string"
}