BatchRejectedEntry

One submitted entry the batch did not create, and why.

A batch checks each destination on its own. An entry Resia cannot use — a destination its policy refuses, a malformed number, or a destination already used earlier in the same batch — is reported here instead of refusing the whole batch. A reported entry is not created: it is not called or texted, and it is not charged.

  • position
    Type: integer
    min:  
    0
    required

    The rejected entry's 0-based index in the submitted list.

  • reason
    Type: string
    required

    Why this entry was rejected, in one sentence.

  • to_phone_number
    Type: string
    max length:  
    64
    required

    The destination exactly as submitted, echoed back so you can match it to your own record.

  • client_reference
    Type: string
    min length:  
    1
    max length:  
    256    nullable

    The label sent on this entry, echoed back unchanged, or null if none was sent.